Blog
Support Center
Explorer's Hub
NR University
NR Status

Skip to Navigation ↓

Manage APM Agents

Installation

Compatibility and requirements
Install the agent
Update the agent
Disable APM agent
Uninstall the agent

App Naming

Name your application
Use multiple names for an app

Agent Data

Custom instrumentation
Link Kubernetes
Agent attributes
Custom attributes
Custom events
Custom metrics
Manage errors

Configuration

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

Maintenance

Agent established releases
Connect hosts to your account
End of life policy

Troubleshooting

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

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
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
Install New Relic Browser
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 agent established releases
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
WildFly version 11 installation
GAE flex
WebSphere App Server
Java agent self-installer
Java 2 security installation
Java SE 5.0 support
Install Java agent using Gradle
Maven install

Heroku

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

Configuration

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

Instrumentation

Transaction naming protocol
Monitor deployments
Browser monitoring
Instrument Kafka message queues
Use RabbitMQ or JMS for message queues
Java agent incubator
Ignore transactions
Browser best practices

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

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
Application server JMX setup

.NET Agent

Getting Started

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

Install

Install introduction
Install .NET Framework agent
Compatibility and requirements (Core)
Install .NET Core agent
Install for Docker
Update the agent
Uninstall the agent
Install resources (advanced)

Azure Install Guides

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

Configuration

.NET agent configuration
Name your .NET application

Other Features

Async support in .NET
Add Browser monitoring

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
IAgent
IDistributedTracePayload
ITransaction
IgnoreApdex
IgnoreTransaction
IncrementCounter
NoticeError
RecordCustomEvent
RecordMetric
RecordResponseTimeMetric
SetApplicationName
SetTransactionName
SetTransactionUri
SetUserParameters
StartAgent

Attributes

.NET agent attributes
.NET attribute examples
Enable and disable attributes

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
CoCreate errors: No event log
CoCreateInstance errors: No profiler log
Missing async metrics
Missing Couchbase metrics
Status monitor
Monitor short-lived processes
Configure TLS protocol
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
.NET profiler conflict with Microsoft Application 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
Node.js agent configuration
Upgrade the Node.js agent
Uninstall the agent

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

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 and CentOS
Ubuntu and Debian
Tar archive
Install agent on shared hosting service
Upgrade the agent

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

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_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

Attributes

PHP agent attributes
Enabling and disabling attributes
Attribute examples

Features

Distributed tracing
Multiple accounts
Browser monitoring
PHP custom instrumentation
Recording deployments

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

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
Advanced install
Upgrade the Python agent
Advanced integration
Admin script: Advanced use
Uninstall the Python agent

Configuration

Python agent configuration

Supported Features

Message queues
Custom metrics
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
Using trace decorators with Tornado coroutines
Tornado 4
Tornado 3
CherryPy
Web2Py
AJP
FastCGI
Paste
SCGI
Waitress

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 the agent
Uninstall the agent

Configuration

Ruby agent configuration
Custom SSL certificates

Features

Message queues
Record deployments
HTTP client tracing in Ruby
Cross application tracing in Ruby
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

Elixir open-source agent

Contents » APM Agents » Ruby Agent

English
日本語

Features

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

©2008–2019 New Relic, Inc. All rights reserved. Terms of Service DMCA Policy Privacy Policy Cookie Policy UK Slavery Act of 2015