Home

Documentation

Your first stop for any and all New Relic questions. Every product, integration, and agent.

Explorers Hub

Find answers to your technical questions and connect with New Relic customers and staff.

Support

Connect with our team of technical experts to find solutions that meet your needs.

New Relic University

NRU provides training that empowers you to gain the insight you need to make better decisions about your digital business.

Expert Services

Our team can help you start, optimize, scale, and achieve the possible with our products.

New Relic Developers

Do more and make the New Relic Platform your own with APIs, SDKs, code snippets, tutorials, and more developer tools.
  • English
  • 日本語

Manage APM Agents

plus icon

Installation

  • Compatibility and requirements
  • Install the agent
  • Update the agent
  • Disable APM agent
  • Uninstall the agent
plus icon

App Naming

  • Name your application
  • Use multiple names for an app
plus icon

Agent Data

  • Custom instrumentation
  • Agent attributes
  • Custom attributes
  • Custom events
  • Custom metrics
  • Manage errors
  • Link Kubernetes
  • Event limits and sampling
plus icon

Configuration

  • Configure the agent
  • Server-side configuration
  • High security mode
  • Configurable security policies
  • Add, rename, and remove hosts
  • Monitor background processes
  • Audit all data transmitted
plus icon

Maintenance

  • Agent established releases
  • Connect hosts to your account
  • End-of-life policy
plus icon

Troubleshooting

  • New Relic Diagnostics
  • Configuration mismatch
  • Not seeing data
  • Find the agent root directory
  • Generate logs
  • Metric grouping issues

C SDK

plus icon

Get Started

  • Introduction to the C SDK
  • Compatibility and requirements
  • C SDK security
  • C SDK release notes
plus icon

Install and Configure

  • Install (compile) the C SDK
  • C SDK configuration
  • Update your C SDK library
  • Uninstall (remove) the C SDK
plus icon

Instrumentation

  • Instrument your app
  • Enable distributed tracing for your C applications
  • Guide to using the C SDK API
  • Use default or custom attributes (C SDK)
plus icon

Troubleshooting

  • No data appears (C SDK)
  • Troubleshooting logs (C SDK)

Go Agent

plus icon

Get Started

  • New Relic for Go
  • Compatibility and requirements
  • Go agent security
  • Go agent release notes
plus icon

Installation

  • Install New Relic for Go
  • Install in GAE flex
  • Update the Go agent
  • Uninstall the Go agent
plus icon

Configuration

  • Go configuration
  • Go agent logging
plus icon

Instrumentation

  • Instrument Go transactions
  • Custom events
  • Instrument Go segments
  • Go agent attributes
  • Create custom metrics in Go
plus icon

API Guides

  • Go agent API guide
plus icon

Features

  • Go runtime UI page
  • Custom events
  • Install New Relic Browser
  • Distributed tracing
  • Trace asynchronous applications
  • Cross application tracing
plus icon

Troubleshooting

  • No data appears

Java Agent

plus icon

Getting Started

  • New Relic for Java
  • Compatibility and requirements
  • Java agent security
  • Java agent established releases
  • Java release notes
plus icon

Installation

  • Install the Java agent
  • Include agent with JVM
  • Update the Java agent
  • Uninstall the Java agent
plus icon

Additional Installation

  • Docker
  • AWS Elastic Beanstalk
  • WildFly installation
  • GAE flex
  • WebSphere App Server
  • Java 2 security installation
  • Java SE 5.0 support
  • Gradle installation
  • Maven install
plus icon

Heroku

  • Java agent and Heroku
  • Scala and Heroku
  • No data appears (Heroku)
plus icon

Configuration

  • Name your Java application
  • Java agent configuration
  • Java agent config file template
  • Hostname logic
  • Distributed tracing
  • Automatic application naming
  • Error configuration
  • Configuring your SSL certificates
plus icon

Attributes

  • Java agent attributes
plus icon

Features

  • JVM metrics page (Java)
plus icon

Instrumentation

  • Transaction naming protocol
  • Monitor deployments
  • Browser monitoring
  • Instrument Kafka message queues
  • Use RabbitMQ or JMS for message queues
  • Instrumentation modules
  • Ignore transactions
  • Browser best practices
plus icon

Custom Instrumentation

  • Java custom instrumentation
  • Custom Instrumentation Editor
  • Scala instrumentation
  • Java instrumentation by XML
  • XML instrumentation example
  • Custom JMX instrumentation
  • Custom JMX YAML examples
  • Troubleshooting Java custom instrumentation
  • Circuit breaker
  • Messaging framework instrumentation
plus icon

API Guides

  • Java agent API guide
  • Java agent API annotation
  • API: Externals, messaging, frameworks
  • API: Annotating example app
  • API example: Datastore and CAT
plus icon

Async Instrumentation

  • Async instrumentation
  • Java async API
  • Troubleshoot async
  • Disable async frameworks
plus icon

Troubleshooting

  • No data appears
  • Determine permissions requirements
  • Gather troubleshooting information
  • All hosts appear as localhost
  • Error bootstrapping Java agent
  • Errors starting Java app server
  • Firewall or traffic connectivity failures
  • Generate logs for troubleshooting
  • Host links missing
  • Solr data does not appear
  • No Browser data appears
  • No log file
  • No stack traces
  • NullPointerException issues
  • Resolve metric grouping issues
  • SSL or connection errors
  • Update legacy Java config
  • Large number of false positive security vulnerabilities
  • Application server JMX setup

.NET Agent

plus icon

Getting Started

  • New Relic for .NET
  • Compatibility and requirements (Framework)
  • Compatibility and requirements (Core)
  • APM agent security: .NET
  • .NET release notes
  • .NET agent established release
plus icon

Install

  • Install introduction
  • Install .NET Framework agent
  • Install .NET Core agent
  • Install for Docker
  • Update the agent
  • Uninstall the agent
  • Install resources (advanced)
plus icon

Azure Install Guides

  • Azure Service Fabric
  • Azure Cloud Services
  • Azure Web Apps
  • Azure Marketplace app
  • Azure troubleshooting
plus icon

Configuration

  • .NET agent configuration
  • Name your .NET application
plus icon

Other Features

  • Async support in .NET
  • Limit log disk space
  • Add Browser monitoring
plus icon

Custom Instrumentation

  • Introduction to .NET custom instrumentation
  • Attribute custom instrumentation
  • XML to create transactions
  • XML to add detail
plus icon

API Guides

  • .NET agent API guide
plus icon

.NET Agent API

  • View all methods
  • AddCustomParameter
  • DisableBrowserMonitoring
  • GetAgent
  • GetBrowserTimingHeader
  • IAgent
  • IDistributedTracePayload
  • ITransaction
  • IgnoreApdex
  • IgnoreTransaction
  • IncrementCounter
  • NoticeError
  • RecordCustomEvent
  • RecordMetric
  • RecordResponseTimeMetric
  • SetApplicationName
  • SetTransactionName
  • SetTransactionUri
  • SetUserParameters
  • StartAgent
plus icon

Attributes

  • .NET agent attributes
  • .NET attribute examples
  • Enable and disable attributes
plus icon

Troubleshooting

  • No data appears
  • Support for Framework 4.0 or lower
  • Generate logs for troubleshooting
  • No Browser data appears
  • Profiler conflicts
  • Handled errors reported
  • No data and registry key permission issues
  • High memory usage
  • Browser injection: Health check conflict
  • CoCreate errors: No event log
  • CoCreateInstance errors: No profiler log
  • Missing async metrics
  • Missing Couchbase metrics
  • Status monitor
  • Monitor short-lived processes
  • No data after disabling TLS 1.0
  • Resolve .NET and SCOM conflicts
plus icon

Azure Troubleshooting

  • Azure Cloud Services: No data appears
  • Azure Web Apps: No data appears
  • Azure Web Apps: Unable to open log file
  • Profiler .dll locks during deployment
  • No data with Microsoft App Insights

Node.js Agent

plus icon

Getting Started

  • New Relic for Node.js
  • Compatibility and requirements
  • Node.js agent security
  • Node.js release notes
plus icon

Installation and Configuration

  • Install the Node.js agent
  • Node.js agent configuration
  • Update the Node.js agent
  • Uninstall the agent
plus icon

Supported Features

  • Node.js custom instrumentation
  • Node.js custom metrics
  • Node.js VMs statistics page
  • Distributed tracing
  • Message queues
  • Browser monitoring
  • Node.js v1 custom instrumentation
  • Node.js VM measurements
plus icon

Attributes

  • Node.js agent attributes
plus icon

API Guides

  • Guide to Node.js agent API
  • Node.js agent API
plus icon

Hosting Services

  • GAE flex
  • Install on Azure Web Apps
  • Node.js agent and Heroku
plus icon

Troubleshooting

  • Troubleshoot your installation
  • Logs for troubleshooting
  • Troubleshoot message consumers
  • Troubleshoot Browser
  • Large memory usage

PHP Agent

plus icon

Getting Started

  • New Relic for PHP
  • Compatibility and requirements
  • New Relic daemon processes
  • PHP agent security
  • PHP agent release notes
plus icon

Installation

  • Installation overview
  • AWS Linux, RedHat and CentOS
  • Ubuntu and Debian
  • Tar archive
  • Install agent on shared hosting service
  • Update the PHP agent
plus icon

Advanced Installation

  • PHP agent and Docker
  • The newrelic-install script
  • Starting the PHP daemon
  • Silent mode newrelic-install script
  • Non-standard PHP
  • PHP agent and Heroku
  • Uninstall the agent
plus icon

Configuration

  • PHP agent configuration
  • Per-Directory INI settings
  • Name your PHP app
  • Proxy daemon settings
plus icon

API Guides

  • API guide
plus icon

PHP Agent API

  • View all methods
  • newrelic_accept_distributed_trace_payload
  • newrelic_accept_distributed_trace_payload_httpsafe
  • newrelic_add_custom_parameter
  • newrelic_add_custom_tracer
  • newrelic_background_job
  • newrelic_capture_params
  • newrelic_create_distributed_trace_payload
  • newrelic_custom_metric
  • newrelic_disable_autorum
  • newrelic_end_of_transaction
  • newrelic_end_transaction
  • newrelic_get_browser_timing_footer
  • newrelic_get_browser_timing_header
  • newrelic_ignore_apdex
  • newrelic_ignore_transaction
  • newrelic_start_transaction
  • newrelic_name_transaction
  • newrelic_notice_error
  • newrelic_record_custom_event
  • newrelic_record_datastore_segment
  • newrelic_set_appname
  • newrelic_set_user_attributes
plus icon

Attributes

  • PHP agent attributes
  • Enable or disable attributes
  • Attribute examples
plus icon

Features

  • Distributed tracing
  • Multiple accounts
  • Browser monitoring
  • PHP custom instrumentation
  • Recording deployments
plus icon

Frameworks and Libraries

  • Integrating support for New Relic
  • Analyze PHPUnit test data in Insights
  • AWS Elastic Beanstalk installation
  • Drupal-specific functionality
  • Guzzle
  • Magento-specific functionality
  • Predis library
  • WordPress-specific functionality
plus icon

Troubleshooting

  • No data appears
  • Agent not reporting errors
  • Determine permissions requirements
  • Generating logs for troubleshooting
  • Data stops reporting while using SELinux
  • Agents stops after updating PHP
  • Checking loaded configuration files directory
  • Missing PHP module
  • Protocol mismatch error
  • INI settings not taking effect immediately
  • Submitting troubleshooting results
  • Threaded Apache worker MPMs
  • Transactions /index.php or /unknown
  • What the PHP instance count means
  • Uninstrumented time in traces
  • Using phpinfo to verify PHP
  • Verifying the PHP daemon
  • When to restart your web server
  • PHP installation fails on El Capitan
  • First transaction not reported
  • Data stops reporting

Python Agent

plus icon

Getting Started

  • New Relic for Python
  • Compatibility and requirements
  • Instrumented Python packages
  • Python agent security
  • Python release notes
plus icon

Installation

  • Standard install
  • Advanced install
  • Update the Python agent
  • Advanced integration
  • Admin script: Advanced use
  • Uninstall the Python agent
plus icon

Configuration

  • Python agent configuration
plus icon

Supported Features

  • Message queues
  • Custom metrics
  • Browser monitoring
  • Monitor scripts and functions
  • Tips and tricks
  • Cross application tracing
  • Browser and Django templates
plus icon

Back-End Services

  • Celery back-end service
plus icon

Custom Instrumentation

  • Custom instrumentation overview
  • Instrumentation via config file
plus icon

API Guides

  • Guide to the API
plus icon

Python Agent API

  • View all calls
  • add_custom_parameters
  • add_custom_parameter
  • application
  • application_settings
  • web_transaction
  • background_task
  • callable_name
  • capture_request_params
  • accept_distributed_trace_payload
  • create_distributed_trace_payload
  • current_transaction
  • datastore_trace
  • data_source_factory
  • data_source_generator
  • disable_browser_autorum
  • end_of_transaction
  • external_trace
  • function_trace
  • get_browser_timing_footer
  • get_browser_timing_header
  • global_settings
  • ignore_transaction
  • initialize
  • message_trace
  • message_transaction
  • record_custom_event
  • record_custom_metrics
  • record_custom_metric
  • record_exception
  • register_application
  • register_data_source
  • set_background_task
  • set_transaction_name
  • shutdown_agent
  • suppress_apdex_metric
  • suppress_transaction_trace
  • wsgi_application
plus icon

Web Frameworks and Servers

  • uWSGI
  • Gunicorn
  • mod_wsgi
  • Tornado 6
  • CherryPy
  • Web2Py
  • AJP
  • FastCGI
  • Paste
  • SCGI
  • Waitress
plus icon

Hosting Services

  • GAE flex
  • Heroku hosting service
  • OpenShift hosting service
  • Stackato hosting service
  • WebFaction hosting service
plus icon

Attributes

  • Python agent attributes
  • Enabling and disabling attributes
  • Attribute examples
plus icon

Troubleshooting

  • No data appears
  • Troubleshooting Browser
  • Emulating legacy parameters
  • Testing the Python agent
  • Python agent logging
  • Activate application warning
  • Missing information when using ensure_future

Ruby Agent

plus icon

Getting Started

  • New Relic for Ruby
  • Requirements and supported frameworks
  • Ruby agent security
  • New Relic's GitHub repository
  • Ruby release notes
plus icon

Installation

  • Ruby agent installation
  • Rails plugin installation
  • GAE flex
  • Ruby agent and Heroku
  • Update the Ruby agent
  • Uninstall the agent
plus icon

Configuration

  • Ruby agent configuration
  • Custom SSL certificates
plus icon

Features

  • Message queues
  • Record deployments
  • HTTP client tracing in Ruby
  • Cross application tracing in Ruby
  • Ruby VM measurements
  • Garbage collection
  • Browser monitoring
  • Developer mode
plus icon

API Guides

  • API guide
  • Ruby custom instrumentation
  • Ruby custom metrics
  • Ignoring specific transactions
  • Reporting handled errors
  • Third party instrumentation
plus icon

Instrumented Gems

  • Redis instrumentation
  • Mongo instrumentation
  • Rack and Metal support
  • Rack middlewares
  • Metal controller instrumentation
  • Sequel instrumentation
  • Sinatra instrumentation
plus icon

Background Jobs

  • Resque instrumentation
  • Rake instrumentation
  • Sidekiq instrumentation
  • Monitor background processes
  • Delayed::Job instrumentation
plus icon

Attributes

  • Enable and disable attributes
  • Ruby agent attributes
  • Attribute examples
plus icon

Troubleshooting

  • No data appears
  • Generating logs
  • Incompatible gems
  • No log file
  • Control when the agent starts
  • SystemStackError: stack level too deep
  • Ruby agent audit log
  • Passenger troubleshooting
  • No data with Unicorn
  • Update private API calls to public Tracer API
  • Update deprecated API calls
  • Not installing Grape

Open-Source Licensed Agents

plus icon

Open-Source Licensed Agents

  • New Relic C SDK
  • Elixir open-source agent
Contents » APM Agents » Python Agent

Custom Instrumentation

  • Python custom instrumentation
  • Python custom instrumentation via config file
©2008–2019 New Relic, Inc. All rights reserved. Terms of Service DMCA Policy Privacy Notice Cookie Policy UK Slavery Act of 2015