Developers
Open Source
Documentation
Community

Log in Free Account

Developers
Open Source
Documentation
Community

Log in Free Account

English
日本語

Manage APM agents

App naming

Name your application
Use multiple names for an app

Agent data

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

Configuration

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

Troubleshooting

Configuration mismatch
Environment and services

C SDK

Get started

Introduction to the C SDK
Compatibility and requirements
C SDK security
C SDK release notes

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

Instrumentation

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

Troubleshooting

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

Go agent

Get started

New Relic for Go
Compatibility and requirements
Go agent security
Go agent release notes

Installation

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

Configuration

Go configuration
Go agent logging

Instrumentation

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

API guides

Go agent API guide

Features

Go runtime UI page
Custom events
Add browser monitoring
Distributed tracing
Trace asynchronous applications
Cross application tracing

Troubleshooting

No data appears

Java agent

Getting started

New Relic for Java
Compatibility and requirements
Java agent security
Java release notes

Installation

Install the Java agent
Include agent with JVM
Update the Java agent
Uninstall the Java agent

Additional installation

Docker
AWS Elastic Beanstalk
Ansible
WildFly installation
GAE flex
WebSphere App Server
Java 2 security installation
Maven install
Gradle installation

Heroku

Java agent and Heroku
Scala and Heroku
No data appears (Heroku)

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

Attributes

Java agent attributes

Features

JVM metrics page (Java)
Real-time profiling for Java

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

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

API guides

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

Async instrumentation

Async instrumentation
Java async API
Troubleshoot async
Disable async frameworks

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

Getting started

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

Install

Install introduction
Install for Windows
Install for Linux
Update the agent
Uninstall the agent

Azure installation

Azure Service Fabric
Azure Cloud Services
Azure Web Apps
Azure Marketplace app
Azure troubleshooting

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)

Configuration

.NET agent configuration
Name your .NET application

Other features

Async support in .NET
Limit log disk space
Add Browser monitoring
.Net Performance Metrics

Custom instrumentation

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

API guides

.NET agent API guide

.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

Attributes

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

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

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

Getting started

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

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

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

Attributes

Node.js agent attributes

API guides

Guide to Node.js agent API
Node.js agent API

Hosting services

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

Troubleshooting

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

PHP agent

Getting started

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

Installation

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

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

Configuration

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

API guides

API guide

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

Attributes

PHP agent attributes
Enable or disable attributes
Attribute examples

Features

Distributed tracing
Multiple accounts
Browser monitoring
PHP custom instrumentation
Recording deployments

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

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

Getting started

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

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

Configuration

Python agent configuration

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

Back-end services

Celery back-end service

Custom instrumentation

Custom instrumentation overview
Instrumentation via config file

API guides

Guide to the API

Python agent API

Web frameworks and servers

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

Async instrumentation

Django ASGI Mode
FastAPI
Asyncpg
Starlette
Uvicorn

Hosting services

GAE flex
Heroku hosting service
OpenShift hosting service
Stackato hosting service
WebFaction hosting service

Attributes

Python agent attributes
Enabling and disabling attributes
Attribute examples

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

Getting started

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

Installation

Ruby agent installation
Rails plugin installation
GAE flex
Ruby agent and Heroku
Update Ruby agent
Uninstall Ruby agent

Configuration

Ruby configuration
Custom SSL certificates
Connect hosts to account

Features

Message queues
Record deployments
Ruby HTTP client tracing
Ruby cross application tracing
Ruby VM measurements
Garbage collection
Browser monitoring
Developer mode

API guides

API guide
Ruby custom instrumentation
Ruby custom metrics
Ignoring specific transactions
Reporting handled errors
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 background processes
Delayed::Job instrumentation

Attributes

Enable and disable attributes
Ruby agent attributes
Attribute examples

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

Open-source licensed agents

New Relic C SDK
Elixir open-source agent
Roku open-source agent

Contents / APM agents / Java agent

Async instrumentation

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

©2008–2021 New Relic, Inc. All rights reserved.

Terms of Service DMCA Policy Privacy Notice Cookie Policy UK Slavery Act of 2015