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