Blog
Support Center
Explorer's Hub
NR University
NR Status
Skip to Navigation
↓
Contents
Agents
Manage APM Agents
Installation
Compatibility and requirements for New Relic agents and products
Install the agent
Update the New Relic agent
Disable the APM agent
Uninstall the agent
App Naming
Name your application
Use multiple names for an app
Agent Data
Custom instrumentation
Agent attributes
Collect custom attributes
Collect custom events
Collect custom metrics
Manage errors in APM: Collect, ignore, or mark as expected
Configuration
Server-side agent configuration
Configure the agent
High security mode
Add, rename, and remove hosts
Monitor background processes
Log (audit) all data your New Relic agent transmits
Maintenance
Agent established releases
Connect hosts to your account
New Relic agent and plugin end of life policy
Troubleshooting
New Relic Diagnostics
Not seeing data
Find the agent root directory
Generate New Relic agent logs for troubleshooting
Metric grouping issues
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 New Relic Go agent in GAE flexible environment
Uninstall the Go agent
Configuration
Go agent configuration
Go agent logging
Instrumentation
Instrument Go transactions
Create custom events in Insights (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 in Insights (Go)
Install New Relic Browser for Go apps
Enable distributed tracing for the Go agent
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 agent established releases
Java release notes
Installation
Install the Java agent
Include the Java agent with a JVM argument
Upgrade the Java agent
Uninstall the Java agent
Additional Installation
Install New Relic Java agent for Docker
AWS Elastic Beanstalk installation for Java
WildFly version 11+ installation for Java
Install New Relic Java agent in GAE flexible environment
IBM WebSphere Application Server
Java agent self-installer
Java 2 security installation
Java SE 5.0 support
Install Java agent using Maven
Heroku
Java agent and Heroku
Java agent with Scala on Heroku
No data appears with Heroku (Java)
Configuration
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
JVM metrics page
Instrumentation
Use RabbitMQ or JMS for message queues
Transaction naming protocol
Monitor deployments (Java agent)
New Relic Browser and the Java agent
Browser best practices in Java
Java agent incubator
Ignore specific transactions
Custom Instrumentation
Java custom instrumentation
Custom Instrumentation Editor: Instrument from UI
Scala instrumentation
Java instrumentation by XML
Java XML instrumentation examples
Custom JMX instrumentation by YAML
Custom JMX YAML examples
Troubleshooting Java custom instrumentation
Circuit breaker for Java custom 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 Overview
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
Application server JMX setup
NET Agent
Getting Started
Introduction to New Relic for .NET
Compatibility and requirements for the .NET Core agent
Compatibility and requirements for the .NET Framework agent
.NET release notes
.NET agent established release
APM agent security: .NET
Installation
Install and enable the New Relic .NET agent
Update the .NET agent
Uninstall the .NET agent
Upgrade legacy .NET Framework agents
Install Guides
Install overview
Install the .NET agent on Windows
Install .NET Core agent on Linux
Install .NET Core agent in Microsoft Docker container
Install .NET agent for ASP.NET Core application
Install .NET Framework agent for WCF applications
Install .NET agent using scriptable installer for Windows system
.NET Framework: Install agent and define target applications
Azure Installation
Install the .NET agent on Azure Service Fabric
Install the .NET agent on Azure Cloud Services
Install the .NET agent on Azure Web Apps
Install Azure app with New Relic
Azure troubleshooting
Configuration
.NET agent configuration
Name your .NET application
Other Features
Async support in .NET
New Relic Browser and the .NET agent
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)
IAgent
IDistributedTracePayload (.NET agent API)
ITransaction
IgnoreApdex (.NET agent API)
IgnoreTransaction (.NET agent API)
IncrementCounter (.NET agent API)
NoticeError (.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)
Attributes
.NET agent attributes
.NET attribute examples
Enable and disable attributes (.NET)
Troubleshooting
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)
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
Configure TLS protocol
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
.NET profiler conflict 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
Node.js agent configuration
Upgrade the Node.js agent
Uninstall the Node.js agent
Supported Features
Node.js custom instrumentation
Node.js custom metrics
Node.js VMs statistics page
Node.js VM measurements
Enable distributed tracing for Node.js agent
Message queues
New Relic Browser and the Node.js agent
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, and CentOS
PHP agent installation: Ubuntu and Debian
PHP agent installation: Tar file
Install PHP agent on shared hosting service
Upgrade the PHP agent
Advanced Installation
Install the PHP agent with Docker
Using the newrelic-install script
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_payload (PHP agent API)
newrelic_accept_distributed_trace_payload_httpsafe (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_ignore_apdex (PHP agent API)
newrelic_ignore_transaction (PHP agent API)
newrelic_start_transaction (PHP agent API)
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)
Attributes
PHP agent attributes
Enabling and disabling attributes
Attribute examples
Features
Distributed tracing for the PHP agent
Multiple accounts
New Relic Browser and the PHP agent
PHP custom instrumentation
Recording deployments using a PHP script
Frameworks and Libraries
PHP frameworks: Integrating support for New Relic
Analyze PHPUnit test data in Insights
AWS Elastic Beanstalk installation for PHP
Drupal-specific functionality
PHP agent support for Guzzle
Magento-specific functionality
Predis
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
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
Advanced install of New Relic Python agent
Upgrade the Python agent
Python agent: Advanced integration
Python agent admin script: Advanced usage
Uninstall the Python agent
Configuration
Python agent configuration
Supported Features
Python message queues
Python custom metrics
New Relic Browser 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_parameter (Python agent API)
add_user_attribute (Python agent API)
application (Python agent API)
application_settings (Python agent API)
background_task (Python agent API)
callable_name (Python agent API)
capture_request_params (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_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)
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
Using trace decorators with Tornado coroutines
Python agent and Tornado 4+ framework
Python agent and Tornado 3 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
Hosting Services
Install New Relic 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)
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
Enabling and disabling 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 deprecated API calls
Not installing New Relic supported Grape
Agent SDK
Getting Started
Introduction to the New Relic Agent SDK
Known limitations with the New Relic Agent SDK
Security considerations with the Agent SDK
Installation and Configuration
Installing the Agent SDK
Configuring Agent SDK logging
Instrumenting your code with the Agent SDK
Configuring the Agent SDK
Limiting or disabling Agent SDK settings
Using the Agent SDK
Using the Agent SDK
Open-Source Licensed Agents
Open-Source Licensed Agents
Elixir open-source agent