• /
  • Log in

shutdown_agent (Python agent API)

Syntax

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 values

None.

Examples

With a three second timeout

newrelic.agent.shutdown_agent(timeout=3)

For more help

If you need more help, check out these support and learning resources:

Create issueEdit page
Copyright © 2021 New Relic Inc.