shutdown_agent

For general information on how the Python agent API calls relate to each other, see the API guide.

newrelic.agent.shutdown_agent(timeout=None)
Forcibly shuts down the agent.

Description

Forcibly shut down the agent. The agent makes a final attempt to upload data to the collector.

Parameters

Parameter Description

timeout

int or float

Optional, but highly recommended. The maximum length of time the caller waits for the agent to finish uploading data. If the timeout period ends before the agent finishes, the agent continues reporting data in the background, but the caller may forcibly kill the whole process and stop the upload.

If no value is set or set to None, the agent uses the default global timeout value, which can be overriden in configuration settings but defaults to 2.5 seconds.

Return value(s)

None.

Example(s)

With a three second timeout

newrelic.agent.shutdown_agent(timeout=3)

For more help

Recommendations for learning more: