• Developers
  • Open Source
  • Documentation
  • Community
  • Log in Free Account
Docs
  • Developers
  • Open Source
  • Documentation
  • Community
  • Log in Free Account
  • English
  • 日本語

Manage APM agents

plus icon

App naming

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

Agent data

  • Real time streaming
  • Custom instrumentation
  • Agent attributes
  • Custom events
  • Custom metrics
  • Manage errors
  • Link Kubernetes
plus icon

Configuration

  • Server-side configuration
  • View config values for your app
  • High security mode
  • Configurable security policies
  • Add, rename, and remove hosts
  • Monitor background processes
plus icon

Troubleshooting

  • Configuration mismatch
  • Environment and services

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
  • Docker and other containers
  • 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
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
  • Add browser monitoring
  • 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 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
  • Ansible
  • WildFly installation
  • GAE flex
  • WebSphere App Server
  • Java 2 security installation
  • Maven install
  • Gradle installation
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)
  • Real-time profiling for Java
plus icon

Instrumentation

  • Transaction naming protocol
  • Monitor deployments
  • Instrument webpages via API
  • Browser best practices
  • Instrument Kafka message queues
  • Use RabbitMQ or JMS for message queues
  • Instrumentation modules
  • Ignore transactions
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
plus icon

Install

  • Install introduction
  • Install for Windows
  • Install for Linux
  • Update the agent
  • Uninstall the agent
plus icon

Azure installation

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

Other installation

  • ASP.NET Core
  • Install with NuGet
  • Install for Docker
  • Install for WCF
  • How to verify the checksum of .NET Agent downloads
  • Install resources (advanced)
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
  • .Net Performance Metrics
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
  • GetLinkingMetadata
  • IAgent
  • IDistributedTracePayload
  • ITransaction
  • ISpan
  • IgnoreApdex
  • NoticeError
  • IgnoreTransaction
  • IncrementCounter
  • RecordCustomEvent
  • RecordMetric
  • RecordResponseTimeMetric
  • SetApplicationName
  • SetTransactionName
  • SetTransactionUri
  • SetUserParameters
  • StartAgent
  • TraceMetadata
plus icon

Attributes

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

Troubleshooting

  • Azure Pipelines wipes out NewRelic.Azure.WebSites.Extension directories
  • Agent changes Content-Type header for WCF apps (.NET)
  • 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
  • Install Node.js agent for Docker
  • Node.js agent configuration
  • Update the Node.js agent
  • Uninstall the agent
plus icon

Extend your instrumentation

  • Node.js custom instrumentation
  • Node.js custom metrics
  • Apollo Server plugin
  • Node.js VMs statistics page
  • Distributed tracing
  • Message queues
  • Browser monitoring
  • Node.js VM measurements
  • Node.js v1 custom instrumentation
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, CentOS
  • Ubuntu and Debian
  • Tar archive
  • Install agent on shared hosting service
  • Update the PHP agent
plus icon

Advanced installation

  • Docker or other containers with PHP
  • 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_headers
  • newrelic_accept_distributed_trace_payload
  • newrelic_accept_distributed_trace_payload_httpsafe
  • newrelic_add_custom_span_parameter
  • 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_get_linking_metadata
  • newrelic_get_trace_metadata
  • newrelic_ignore_apdex
  • newrelic_ignore_transaction
  • newrelic_insert_distributed_trace_headers
  • newrelic_is_sampled
  • newrelic_name_transaction
  • newrelic_notice_error
  • newrelic_record_custom_event
  • newrelic_record_datastore_segment
  • newrelic_set_appname
  • newrelic_set_user_attributes
  • newrelic_start_transaction
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

  • Integrate support for New Relic
  • Analyze PHPUnit test data in New Relic
  • 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
  • Install the Python agent for Docker
  • 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

  • Custom metrics
  • Message queues
  • Event loop diagnostics
  • 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_span_attribute
  • add_custom_parameters
  • add_custom_parameter
  • application
  • application_settings
  • web_transaction
  • background_task
  • callable_name
  • capture_request_params
  • accept_distributed_trace_headers
  • insert_distributed_trace_headers
  • 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_linking_metadata
  • 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
  • asgi_application
  • wsgi_application
plus icon

Web frameworks and servers

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

Async instrumentation

  • Django ASGI Mode
  • FastAPI
  • Asyncpg
  • Starlette
  • Uvicorn
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 Ruby agent
  • Uninstall Ruby agent
plus icon

Configuration

  • Ruby configuration
  • Custom SSL certificates
  • Connect hosts to account
plus icon

Features

  • Message queues
  • Record deployments
  • Ruby HTTP client tracing
  • Ruby cross application tracing
  • 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
  • Roku open-source agent
Contents / APM agents / Python agent

Custom instrumentation

Custom instrumentation

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