Developers
Open Source
Documentation
Community
Sign up
or Log into
New Relic One
Docs
Developers
Open Source
Documentation
Community
Sign up
or Log into
New Relic One
Language
English
日本語
Contents
Agents
Manage APM agents
App naming
Name your application
Use multiple names for an app
Agent data
Real time streaming
Custom instrumentation
Agent attributes
Collect custom events
Collect custom metrics
Manage errors in APM: Collect, ignore, or mark as expected
Link your applications to Kubernetes
Configuration
Server-side agent configuration
View config values for your app
High security mode
Enable configurable security policies
Add, rename, and remove hosts
Monitor background processes
Troubleshooting
Agent NRIntegrationErrors appear in Insights
Get environment data about your APM app
C SDK
Get started
Introduction to the C SDK
C SDK compatibility and requirements
APM security: C SDK
C SDK release notes
Install and configure
Install the C SDK: Compile and link your code
Docker and other container environments: Install C SDK
C SDK configuration
Update your C SDK library
Uninstall (remove) the C SDK
Instrumentation
Instrument your app with the C SDK
Enable distributed tracing for your C applications
Guide to using the C SDK API
Use default or custom attributes (C SDK)
Troubleshooting
No data appears (C SDK)
Generate logs for troubleshooting (C SDK)
Go agent
Get started
Introduction to New Relic for Go
Go agent compatibility and requirements
APM agent security: Go
Go agent release notes
Installation
Install New Relic for Go
Install the Go agent in GAE flexible environment
Update the Go agent
Uninstall the Go agent
Configuration
Go agent configuration
Go agent logging
Instrumentation
Instrument Go transactions
Create custom events (Go)
Instrument Go segments
Go agent attributes
Create custom metrics in Go
API guides
Guide to using the Go agent API
Features
Go runtime page: Troubleshoot performance problems
Create custom events (Go)
Add browser monitoring to your Go apps
Enable distributed tracing for your Go applications
Trace asynchronous applications
Cross application tracing with Go
Troubleshooting
No data appears (Go)
Java agent
Getting started
Introduction to New Relic for Java
Compatibility and requirements for the Java agent
APM agent security: Java
Java release notes
Installation
Install the Java agent
Include the Java agent with a JVM argument
Update the Java agent
Uninstall the Java agent
Additional installation
Install New Relic Java agent for Docker
AWS Elastic Beanstalk installation for Java
Install New Relic Java agent with Ansible
WildFly installation for Java
Install New Relic Java agent in GAE flexible environment
IBM WebSphere Application Server
Java 2 security installation
Install Java agent using Maven
Install Java agent using Gradle
Heroku
Java agent and Heroku
Java agent with Scala on Heroku
No data appears with Heroku (Java)
Configuration
Name your Java application
Java agent configuration: Config file
Java agent config file template
Hostname logic in Java
Enable distributed tracing for Java agent
Automatic application naming
Java agent error configuration
Configuring your SSL certificates
Attributes
Java agent attributes
Features
JVMs page (Java): View app server metrics from JMX
Real-time profiling for Java using JFR metrics
Instrumentation
Transaction naming protocol
Monitor deployments (Java agent)
Instrument browser monitoring with Java agent API
Browser monitoring best practices in Java
Java agent: Instrument Kafka message queues
Use RabbitMQ or JMS for message queues
Extension and additional instrumentation modules
Ignore specific transactions
Custom instrumentation
Java custom instrumentation
Custom instrumentation editor: Instrument from UI
Scala instrumentation
Java instrumentation by XML
Java XML instrumentation examples
Java agent: Custom JMX instrumentation by YAML
Custom JMX YAML examples
Troubleshooting Java custom instrumentation
Circuit breaker for Java custom instrumentation
Messaging framework instrumentation
API guides
Guide to using the Java agent API
Java agent API: Instrument using annotation
Java agent API: Instrument external calls, messaging, datastore, web frameworks
Java agent API: Custom instrumentation with annotation of an example app
Java agent API: Instrumenting example app for external datastore calls and CAT
Async instrumentation
Introduction to Java async instrumentation
Java agent API for asynchronous applications
Troubleshoot Java asynchronous instrumentation
Disable Scala, Netty, Akka, and Play 2 Instrumentation
Troubleshooting
No data appears (Java)
Determine permissions requirements (Java)
Gather troubleshooting information (Java)
All hosts appear as localhost
Error bootstrapping New Relic Java agent
Errors starting Java app server
Firewall or traffic connectivity failures
Generate debug logs for troubleshooting (Java)
Host links missing in Java app's APM Summary
Java Solr data does not appear
No Browser data appears (Java)
No log file (Java)
No stack traces (Java)
NullPointerException issues (Java)
Resolve metric grouping issues with Java apps
SSL or connection errors (Java)
Update Java config for legacy agent versions
Large number of false positive security vulnerabilities
Application server JMX setup
NET agent
Getting started
Introduction to New Relic for .NET
.NET agent: compatibility and requirements for .NET Framework
.NET agent: compatibility and requirements for .NET Core
APM agent security: .NET
.NET release notes
Installation
Introduction to .NET agent install
Install .NET agent for Windows
Install .NET agent for Linux
Update the .NET agent
Uninstall the .NET agent
Azure installation
Install .NET agent on Azure Service Fabric
Install the .NET agent on Azure Cloud Services
Install the .NET agent on Azure Web Apps
Install Azure Marketplace app with New Relic
Azure troubleshooting
Other installation
Install .NET agent for ASP.NET Core
Install the .NET agent using NuGet
Install .NET agent on Docker container
Install .NET agent for Windows Communication Foundation (WCF)
How to verify the checksum of .NET Agent downloads
.NET agent install resources
Configuration
.NET agent configuration
Name your .NET application
Other features
Async support in .NET
Limit log disk space with log rolling
Browser monitoring and the .NET agent
.Net Performance Metrics
Custom instrumentation
Introduction to .NET custom instrumentation
Custom instrumentation via attributes (.NET)
Create transactions via XML (.NET)
Add detail to transactions via XML (.NET)
API guides
Guide to using the .NET agent API
NET agent API
View all methods
AddCustomParameter (.NET agent API)
DisableBrowserMonitoring (.NET agent API)
GetAgent
GetBrowserTimingHeader (.NET agent API)
GetLinkingMetadata (.NET agent API)
IAgent
IDistributedTracePayload (.NET agent API)
ITransaction
ISpan
IgnoreApdex (.NET agent API)
NoticeError (.NET agent API)
IgnoreTransaction (.NET agent API)
IncrementCounter (.NET agent API)
RecordCustomEvent (.NET agent API)
RecordMetric (.NET agent API)
RecordResponseTimeMetric (.NET agent API)
SetApplicationName (.NET agent API)
SetTransactionName (.NET agent API)
SetTransactionUri (.NET agent API)
SetUserParameters (.NET agent)
StartAgent (.NET agent API)
TraceMetadata (.NET agent API)
Attributes
Custom attributes (.NET)
.NET agent attributes
.NET attribute examples
Enable and disable attributes (.NET)
Troubleshooting
Azure Pipelines wipes out NewRelic.Azure.WebSites.Extension directories
Agent changes Content-Type header for WCF apps (.NET)
No data appears (.NET)
Technical support for .NET Framework 4.0 or lower
Generate logs for troubleshooting (.NET)
No Browser data appears (.NET)
Profiler conflicts
.NET agent reports handled errors
No data and registry key permission issues
High memory usage (.NET)
Browser injection: Health check conflict
CoCreate errors: No event log
CoCreateInstance errors: No profiler log
Missing .NET async metrics
Missing Couchbase metrics (.NET)
New Relic for .NET status monitor
Monitor short-lived .NET processes
No data appears after disabling TLS 1.0
Resolve .NET and SCOM conflicts
Azure troubleshooting
Azure Cloud Services: No data appears
Azure Web Apps: Using Always On and no data appears
Azure Web Apps: Unable to open log file
Azure Web Apps: Profiler .dll locks during deployment
No data reporting with Microsoft Application Insights
Nodejs agent
Getting started
Introduction to New Relic for Node.js
Compatibility and requirements for the Node.js agent
APM agent security: Node.js
Node.js release notes
Installation and configuration
Install the Node.js agent
Install the Node.js agent for Docker
Node.js agent configuration
Update the Node.js agent
Uninstall the Node.js agent
Extend your instrumentation
Node.js custom instrumentation
Node.js custom metrics
Apollo Server plugin and Node.js
Node.js VMs statistics page
Enable distributed tracing for Node.js agent
Message queues
Browser monitoring and the Node.js agent
Node.js VM measurements
Node.js v1 custom instrumentation (legacy)
Attributes
Node.js agent attributes
API guides
Guide to using the Node.js agent API
Node.js agent API
Hosting services
Install New Relic Node.js agent in GAE flexible environment
Node.js agent on Microsoft Azure Web Apps
Node.js agent and Heroku
Troubleshooting
Troubleshoot your Node.js installation
Generate trace log for troubleshooting (Node.js)
Troubleshoot message consumers
Troubleshoot browser instrumentation in Node.js
Troubleshooting large memory usage (Node.js)
PHP agent
Getting started
Introduction to New Relic for PHP
PHP agent compatibility and requirements
New Relic daemon processes
APM agent security: PHP
PHP agent release notes
Installation
PHP agent installation overview
PHP agent installation: AWS Linux, RedHat, CentOS
PHP agent installation: Ubuntu and Debian
PHP agent installation: Tar file
Install PHP agent on shared hosting service
Update the PHP agent
Advanced installation
Docker and other container environments: Install PHP agent
Use the newrelic-install script for PHP
Starting the PHP daemon (advanced)
Silent mode for the install script (advanced)
PHP agent installation: Non-standard PHP (advanced)
PHP agent and Heroku
Uninstall the PHP agent
Configuration
PHP agent configuration
PHP per-directory INI settings
Name your PHP application
Proxy daemon (newrelic.cfg) settings
API guides
Guide to using the PHP agent API
PHP agent API
View all methods
newrelic_accept_distributed_trace_headers
newrelic_accept_distributed_trace_payload (PHP agent API)
newrelic_accept_distributed_trace_payload_httpsafe (PHP agent API)
newrelic_add_custom_span_parameter (PHP agent API)
newrelic_add_custom_parameter (PHP agent API)
newrelic_add_custom_tracer (PHP agent API)
newrelic_background_job (PHP agent API)
newrelic_capture_params (PHP agent API)
newrelic_create_distributed_trace_payload (PHP agent API)
newrelic_custom_metric (PHP agent API)
newrelic_disable_autorum (PHP agent API)
newrelic_end_of_transaction (PHP agent API)
newrelic_end_transaction (PHP agent API)
newrelic_get_browser_timing_footer (PHP agent API)
newrelic_get_browser_timing_header (PHP agent API)
newrelic_get_linking_metadata
newrelic_get_trace_metadata
newrelic_ignore_apdex (PHP agent API)
newrelic_ignore_transaction (PHP agent API)
newrelic_insert_distributed_trace_headers
newrelic_is_sampled
newrelic_name_transaction (PHP agent API)
newrelic_notice_error (PHP agent API)
newrelic_record_custom_event (PHP agent API)
newrelic_record_datastore_segment (PHP agent API)
newrelic_set_appname (PHP agent API)
newrelic_set_user_attributes (PHP agent API)
newrelic_start_transaction (PHP agent API)
Attributes
PHP agent attributes
Enable or disable attributes
Attribute examples
Features
Distributed tracing for the PHP agent
Multiple accounts
Browser monitoring and the PHP agent
PHP custom instrumentation
Recording deployments using a PHP script
Frameworks and libraries
PHP frameworks: Integrate support for New Relic
Analyze PHPUnit test data in New Relic
AWS Elastic Beanstalk installation for PHP
Drupal-specific functionality
PHP agent support for Guzzle
Magento-specific functionality
Predis library in PHP
WordPress specific functionality
Troubleshooting
No data appears (PHP)
PHP agent not reporting errors
Determine permissions requirements (PHP)
Generating logs for troubleshooting (PHP)
Data stops reporting while using SELinux
Agent stops working after updating PHP
Checking loaded configuration files directory
Missing PHP module
Protocol mismatch error
INI settings not taking effect immediately
Submitting troubleshooting results (PHP)
Threaded Apache worker MPMs
Transactions named /index.php or /unknown
Troubleshoot the PHP agent instance count
Uninstrumented time in traces
Using phpinfo to verify PHP
Verifying the PHP daemon
Why and when to restart your web server (PHP)
PHP installation fails on OS X 10.11 - El Capitan
First PHP transaction is not reported
Data stops reporting
Python agent
Getting started
Introduction to New Relic for Python
Compatibility and requirements for the Python agent
Instrumented Python packages
APM agent security: Python
Python release notes
Installation
Standard Python agent install
Install the Python agent for Docker
Advanced install of New Relic Python agent
Update the Python agent
Python agent: Advanced integration
Python agent admin script: Advanced usage
Uninstall the Python agent
Configuration
Python agent configuration
Supported features
Python custom metrics
Python message queues
Python event loop diagnostics
Browser monitoring and the Python agent
Monitor non-web scripts, worker processes, tasks, and functions
Python tips and tricks
Cross application tracing
Optional manual Browser instrumentation with Django templates
Back-end services
Python agent and Celery
Custom instrumentation
Python custom instrumentation
Python custom instrumentation via config file
API guides
Guide to using the Python agent API
Python agent API
View all Python agent API calls
add_custom_span_attribute (Python agent API)
add_custom_parameters (Python agent API)
add_custom_parameter (Python agent API)
application (Python agent API)
application_settings (Python agent API)
web_transaction
background_task (Python agent API)
callable_name (Python agent API)
capture_request_params (Python agent API)
accept_distributed_trace_headers (Python agent API)
insert_distributed_trace_headers (Python agent API)
accept_distributed_trace_payload (Python agent API)
create_distributed_trace_payload (Python agent API)
current_transaction (Python agent API)
datastore_trace (Python agent API)
data_source_factory (Python agent API)
data_source_generator (Python agent API)
disable_browser_autorum (Python agent API)
end_of_transaction (Python agent API)
external_trace (Python agent API)
function_trace (Python agent API)
get_browser_timing_footer (Python agent API)
get_linking_metadata (Python agent API)
get_browser_timing_header (Python agent API)
global_settings (Python agent API)
ignore_transaction (Python agent API)
initialize (Python agent API)
message_trace (Python agent API)
message_transaction (Python agent API)
record_custom_event (Python agent API)
record_custom_metrics (Python agent API)
record_custom_metric (Python agent API)
record_exception (Python agent API)
register_application (Python agent API)
register_data_source (Python agent API)
set_background_task (Python agent API)
set_transaction_name (Python agent API)
shutdown_agent (Python agent API)
suppress_apdex_metric (Python agent API)
suppress_transaction_trace (Python agent API)
asgi_application (Python agent API)
wsgi_application (Python agent API)
Web frameworks and servers
Python agent and uWSGI web server
Python agent and Gunicorn WSGI web server
Python agent and mod_wsgi web server
Python agent and FastAPI web framework
Python agent and Starlette web framework
Uvicorn
Python agent and Tornado 6 web framework
Python agent and CherryPy web framework
Python agent and Web2py web framework
Python agent and AJP WSGI server
Python agent and FastCGI web server
Python agent and Paste
Python agent and SCGI web server
Python agent and Waitress web server
Async instrumentation
Django ASGI Mode
Python agent and FastAPI web framework
Asyncpg
Python agent and Starlette web framework
Uvicorn
Hosting services
Install the Python agent in GAE flexible environment
Python agent and Heroku
Python agent and OpenShift
Python agent and Stackato
Python agent and WebFaction
Attributes
Python agent attributes
Enabling and disabling attributes (Python)
Python attribute examples
Troubleshooting
No data appears (Python)
Troubleshooting Browser instrumentation in Python
Emulating legacy server-side parameter configuration (Python)
Testing the Python agent
Python agent logging
Activate application warning (Python)
Missing information when using ensure_future (Python)
Ruby agent
Getting started
Introduction to New Relic for Ruby
Ruby agent requirements and supported frameworks
APM agent security: Ruby
New Relic's GitHub repository
Ruby release notes
Installation
Install the New Relic Ruby agent
Ruby agent installation: Rails plugin
Install New Relic Ruby agent in GAE flexible environment
Ruby agent and Heroku
Update the Ruby agent
Uninstall the Ruby agent
Configuration
Ruby agent configuration
Custom SSL certificates (Ruby)
Connect hosts to your account
Features
Message queues
Record deployments with the Ruby agent
HTTP client tracing in Ruby
Cross application tracing in Ruby
Ruby VM measurements
Garbage collection
New Relic Browser and the Ruby agent
Developer mode
API guides
Guide to using the Ruby agent API
Ruby custom instrumentation
Ruby custom metrics
Ignoring specific transactions
Sending handled errors to New Relic
Third party instrumentation
Instrumented gems
Redis instrumentation
Mongo instrumentation
Rack and Metal support
Rack middlewares
Metal controller instrumentation
Sequel instrumentation
Sinatra instrumentation
Background jobs
Resque instrumentation
Rake instrumentation
Sidekiq instrumentation
Monitor Ruby background processes
Delayed::Job instrumentation
Attributes
Enable and disable attributes (Ruby)
Ruby agent attributes
Ruby attribute examples
Troubleshooting
No data appears (Ruby)
Generating logs for troubleshooting (Ruby)
Incompatible gems
No log file (Ruby)
Control when the Ruby 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 New Relic supported Grape
Open-source licensed agents
Open-source licensed agents
New Relic C SDK
Elixir open-source agent
Roku open-source agent
