Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: ".NET agent supportability metrics"
tags:
- Agents
- NET agent
- Troubleshooting
- Performance monitoring
metaDescription: "Use .NET agent supportability metrics to troubleshoot performance issues, validate configuration, and monitor agent health in your applications."
redirects:
- /docs/apm/supportability-metrics/net-agent-supportability-metrics
freshnessValidatedDate: never
---

import { Redirect } from '@docusaurus/router';

<Redirect to="/docs/apm/supportability-metrics/net-agent-supportability-metrics" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "C SDK supportability metrics"
tags:
- APM
- Supportability metrics
- C SDK
- Troubleshooting
- Performance monitoring
metaDescription: "Use C SDK supportability metrics to troubleshoot performance issues, validate configuration, and monitor agent health in your applications."
freshnessValidatedDate: never
---

<Callout variant="important">
This documentation is currently under development. For immediate assistance with C SDK supportability metrics, please contact [New Relic Support](https://support.newrelic.com/).
</Callout>

C SDK supportability metrics help you understand how your C SDK is performing and identify potential issues with your application monitoring. These metrics provide valuable insights into agent behavior, feature adoption, and configuration effectiveness.

## Coming soon

Detailed C SDK supportability metrics documentation is being developed. For concepts that apply to all agents, see the [general supportability metrics introduction](/docs/apm/supportability-metrics/introduction).

## Next steps

* Learn more about [C SDK configuration](/docs/apm/agents/c-sdk/install-configure/install-c-sdk-compile-link-your-code)
* Explore [C SDK troubleshooting guides](/docs/apm/agents/c-sdk/troubleshooting)
* Set up [custom dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards) to visualize your metrics
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "Go agent supportability metrics"
tags:
- APM
- Supportability metrics
- Go agent
- Troubleshooting
- Performance monitoring
metaDescription: "Use Go agent supportability metrics to troubleshoot performance issues, validate configuration, and monitor agent health in your applications."
freshnessValidatedDate: never
---

<Callout variant="important">
This documentation is currently under development. For immediate assistance with Go agent supportability metrics, please contact [New Relic Support](https://support.newrelic.com/).
</Callout>

Go agent supportability metrics help you understand how your Go agent is performing and identify potential issues with your application monitoring. These metrics provide valuable insights into agent behavior, feature adoption, and configuration effectiveness.

## Coming soon

Detailed Go agent supportability metrics documentation is being developed. For concepts that apply to all agents, see the [general supportability metrics introduction](/docs/apm/supportability-metrics/introduction).

## Next steps

* Learn more about [Go agent configuration](/docs/apm/agents/go-agent/configuration/go-agent-configuration)
* Explore [Go agent troubleshooting guides](/docs/apm/agents/go-agent/troubleshooting)
* Set up [custom dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards) to visualize your metrics
245 changes: 245 additions & 0 deletions src/content/docs/apm/supportability-metrics/introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,245 @@
---
title: "APM supportability metrics"
tags:
- APM
- Supportability metrics
- Troubleshooting
- Performance monitoring
metaDescription: "Use APM supportability metrics to troubleshoot performance issues, validate configuration, and monitor agent health across all New Relic APM agents."
redirects:
- /docs/apm/agents/manage-apm-agents/supportability-metrics
freshnessValidatedDate: never
---

APM supportability metrics help you understand how your New Relic agents are performing and identify potential issues with your application monitoring. These metrics provide valuable insights into agent behavior, feature adoption, and configuration effectiveness across all supported programming languages.

<Callout variant="important">
You're charged for supportability metric ingest as part of your New Relic data consumption. These metrics provide valuable troubleshooting and optimization information that can help you resolve issues faster and improve application performance.
</Callout>

## What are supportability metrics? [#what-are-supportability-metrics]

Supportability metrics are specialized metrics that APM agents automatically collect about their own operation. They help you:

* **Troubleshoot monitoring issues**: Identify why certain data isn't appearing in your dashboards
* **Validate configuration**: Confirm that features like distributed tracing or logging are working correctly
* **Monitor agent performance**: Track resource usage and identify potential bottlenecks
* **Optimize feature usage**: Understand which agent features your application is using most
* **Track agent health**: Monitor connection status and data transmission success rates

All supportability metrics use the `Supportability/` prefix in their metric names, making them easy to identify and query with [NRQL](/docs/query-your-data/nrql-new-relic-query-language/get-started/introduction-nrql-new-relics-query-language/).

## Common supportability metric categories [#metric-categories]

While each APM agent has unique supportability metrics, most agents share these common categories:

### Distributed tracing metrics
Monitor the health and performance of distributed tracing across your services. These metrics help identify configuration issues and connectivity problems between instrumented applications.

**Example metrics:**
* `Supportability/DistributedTrace/CreatePayload/Success`
* `Supportability/TraceContext/Accept/Success`
* `Supportability/TraceContext/Accept/Exception`

### Agent collector communication
Track communication between your agents and New Relic's data collection service. Monitor connection success rates, data transmission volumes, and potential bottlenecks.

**Example metrics:**
* `Supportability/Agent/Collector/connect/Success`
* `Supportability/Agent/Collector/DataSent`
* `Supportability/EventHarvest/HarvestLimitReached`

### Application logging metrics
Monitor the performance and configuration of New Relic's application logging features, including log forwarding and local decoration.

**Example metrics:**
* `Supportability/Logging/Forwarding/Sent`
* `Supportability/Logging/LocalDecorating/enabled`

### Performance and instrumentation metrics
Understand agent overhead, instrumentation effectiveness, and runtime performance impact.

**Example metrics:**
* `Supportability/AgentTiming/*` (various timing measurements)
* `Supportability/Library/*` (instrumented library tracking)

### Environment and configuration metrics
Gather information about your runtime environment, agent version, and configuration details.

**Example metrics:**
* `Supportability/AgentVersion/*`
* `Supportability/utilization/*` (cloud platform detection)

## Querying supportability metrics [#querying-metrics]

Use NRQL to analyze your supportability metrics. Here are some useful query patterns:

<CollapserGroup>
<Collapser
id="query-all-supportability"
title="List all supportability metrics for your account"
>
```sql
SELECT uniques(metricName)
FROM Metric
WHERE metricName LIKE 'Supportability/%'
SINCE 1 day ago
LIMIT MAX
```
</Collapser>

<Collapser
id="query-agent-health"
title="Monitor overall agent health"
>
```sql
SELECT
count(*) as 'Total Metrics',
uniqueCount(appName) as 'Apps Reporting',
uniqueCount(host) as 'Hosts Reporting'
FROM Metric
WHERE metricName LIKE 'Supportability/%'
SINCE 1 hour ago
TIMESERIES
```
</Collapser>

<Collapser
id="query-by-agent-type"
title="Group metrics by agent type"
>
```sql
SELECT
count(*) as 'Metric Count',
appName,
capture(metricName, r'Supportability/([^/]+)') as 'Metric Category'
FROM Metric
WHERE metricName LIKE 'Supportability/%'
SINCE 1 hour ago
FACET appName, `Metric Category`
```
</Collapser>
</CollapserGroup>

## Agent-specific documentation [#agent-specific]

Each APM agent generates unique supportability metrics based on its language, framework integrations, and specific features. For detailed information about metrics for your programming language:

<ButtonGroup>
<ButtonLink
role="button"
to="/docs/apm/supportability-metrics/net-agent-supportability-metrics"
variant="primary"
>
.NET agent metrics
</ButtonLink>

<ButtonLink
role="button"
to="/docs/apm/supportability-metrics/java-agent-supportability-metrics"
variant="primary"
>
Java agent metrics
</ButtonLink>
</ButtonGroup>

<ButtonGroup>
<ButtonLink
role="button"
to="/docs/apm/supportability-metrics/nodejs-agent-supportability-metrics"
variant="primary"
>
Node.js agent metrics
</ButtonLink>

<ButtonLink
role="button"
to="/docs/apm/supportability-metrics/python-agent-supportability-metrics"
variant="primary"
>
Python agent metrics
</ButtonLink>
</ButtonGroup>

<ButtonGroup>
<ButtonLink
role="button"
to="/docs/apm/supportability-metrics/ruby-agent-supportability-metrics"
variant="primary"
>
Ruby agent metrics
</ButtonLink>

<ButtonLink
role="button"
to="/docs/apm/supportability-metrics/php-agent-supportability-metrics"
variant="primary"
>
PHP agent metrics
</ButtonLink>
</ButtonGroup>

<ButtonGroup>
<ButtonLink
role="button"
to="/docs/apm/supportability-metrics/go-agent-supportability-metrics"
variant="primary"
>
Go agent metrics
</ButtonLink>

<ButtonLink
role="button"
to="/docs/apm/supportability-metrics/c-sdk-supportability-metrics"
variant="primary"
>
C SDK metrics
</ButtonLink>
</ButtonGroup>

## Troubleshooting with supportability metrics [#troubleshooting]

### Common troubleshooting scenarios

| Problem | What to check | Key metrics to monitor |
|---------|---------------|------------------------|
| **Missing transaction data** | Data harvest and transmission | `TotalEventsSeen` vs `TotalEventsSent` |
| **Distributed traces not connecting** | Trace context creation and acceptance | `TraceContext/Create/Success`, `Accept/Success` |
| **High agent overhead** | Performance timing metrics | `AgentTiming/*` metrics |
| **Configuration issues** | Agent connection and feature enablement | `Agent/Collector/connect/*` metrics |
| **Log data not appearing** | Logging feature health | `Logging/Forwarding/*` metrics |

### Creating effective dashboards

Build custom dashboards to monitor your agent health:

1. **Agent Health Overview**: Connection success rates, data transmission volumes
2. **Performance Impact**: Agent timing metrics, resource usage
3. **Feature Adoption**: API usage metrics, feature-specific counters
4. **Data Quality**: Compare data seen vs. sent across different event types

### Setting up alerts

Monitor critical supportability metrics with [NRQL alert conditions](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-nrql-alert-conditions/):

* **Data loss detection**: Alert when events seen significantly exceed events sent
* **Connection problems**: Alert on repeated collector connection failures
* **Performance degradation**: Alert on high agent timing values
* **Configuration drift**: Alert when expected metrics stop reporting

## Data retention and costs [#retention-costs]

Supportability metrics follow the same [data retention rules](/docs/telemetry-data-platform/get-data-new-relic/manage-data/manage-retention-stored-data) as other metric data in your New Relic account. Consider:

* **Volume**: Each agent reports dozens of supportability metrics
* **Frequency**: Most metrics report every harvest cycle (typically 60 seconds)
* **Cost optimization**: Use targeted querying and alerting to focus on the most valuable metrics
* **Retention**: Standard metric retention applies (varies by subscription level)

## Next steps [#next-steps]

* Choose your specific agent documentation above to explore detailed metric definitions
* Learn more about [NRQL querying](/docs/query-your-data/nrql-new-relic-query-language/get-started/introduction-nrql-new-relics-query-language) to analyze your metrics
* Set up [custom dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards) to visualize agent health
* Create [alert conditions](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-nrql-alert-conditions/) for proactive monitoring
* Explore [APM troubleshooting guides](/docs/apm/new-relic-apm/troubleshooting) for additional problem-solving resources
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: "Java agent supportability metrics"
tags:
- APM
- Supportability metrics
- Java agent
- Troubleshooting
- Performance monitoring
metaDescription: "Use Java agent supportability metrics to troubleshoot performance issues, validate configuration, and monitor agent health in your Java applications."
freshnessValidatedDate: never
---

<Callout variant="important">
This documentation is currently under development. For immediate assistance with Java agent supportability metrics, please contact [New Relic Support](https://support.newrelic.com/).
</Callout>

Java agent supportability metrics help you understand how your Java agent is performing and identify potential issues with your application monitoring. These metrics provide valuable insights into agent behavior, feature adoption, and configuration effectiveness.

## Coming soon

Detailed Java agent supportability metrics documentation is being developed. This will include:

* **Distributed tracing metrics** - Monitor trace context creation and acceptance
* **Agent collector communication** - Track data transmission and connection health
* **Application logging metrics** - Monitor log forwarding and decoration features
* **Performance metrics** - Understand agent overhead and timing
* **Environment metrics** - Runtime and configuration information
* **API usage metrics** - Track New Relic Java agent API usage

## General supportability metrics information

While this specific documentation is in development, you can:

* Review the [general supportability metrics introduction](/docs/apm/supportability-metrics/introduction) for concepts that apply to all agents
* Use [NRQL queries](/docs/query-your-data/nrql-new-relic-query-language/get-started/introduction-nrql-new-relics-query-language) to explore existing Java agent supportability metrics:

```sql
SELECT uniques(metricName)
FROM Metric
WHERE metricName LIKE 'Supportability/%'
AND appName LIKE '%your-java-app%'
SINCE 1 day ago
LIMIT MAX
```

## Next steps

* Learn more about [Java agent configuration](/docs/apm/agents/java-agent/configuration/java-agent-configuration-config-file)
* Explore [Java agent troubleshooting guides](/docs/apm/agents/java-agent/troubleshooting)
* Set up [custom dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards) to visualize your metrics
Loading
Loading