From 9bd76e2a3a1618170765bb7c6dfe86a0e66997a8 Mon Sep 17 00:00:00 2001 From: cbehera-newrelic Date: Thu, 23 Oct 2025 22:02:00 +0530 Subject: [PATCH] wip --- .../supportability-metrics-net.mdx | 16 + .../c-sdk-supportability-metrics.mdx | 27 ++ .../go-supportability-metrics.mdx | 27 ++ .../supportability-metrics/introduction.mdx | 245 +++++++++++++++ .../java-agent-supportability-metrics.mdx | 50 +++ .../net-agent-supportability-metrics.mdx | 294 ++++++++++++++++++ .../nodejs-agent-supportability-metrics.mdx | 50 +++ .../php-supportability-metrics.mdx | 27 ++ .../python-agent-supportability-metrics.mdx | 27 ++ .../ruby-supportability-metrics.mdx | 27 ++ src/nav/apm.yml | 20 ++ 11 files changed, 810 insertions(+) create mode 100644 src/content/docs/apm/agents/net-agent/other-features/supportability-metrics-net.mdx create mode 100644 src/content/docs/apm/supportability-metrics/c-sdk-supportability-metrics.mdx create mode 100644 src/content/docs/apm/supportability-metrics/go-supportability-metrics.mdx create mode 100644 src/content/docs/apm/supportability-metrics/introduction.mdx create mode 100644 src/content/docs/apm/supportability-metrics/java-agent-supportability-metrics.mdx create mode 100644 src/content/docs/apm/supportability-metrics/net-agent-supportability-metrics.mdx create mode 100644 src/content/docs/apm/supportability-metrics/nodejs-agent-supportability-metrics.mdx create mode 100644 src/content/docs/apm/supportability-metrics/php-supportability-metrics.mdx create mode 100644 src/content/docs/apm/supportability-metrics/python-agent-supportability-metrics.mdx create mode 100644 src/content/docs/apm/supportability-metrics/ruby-supportability-metrics.mdx diff --git a/src/content/docs/apm/agents/net-agent/other-features/supportability-metrics-net.mdx b/src/content/docs/apm/agents/net-agent/other-features/supportability-metrics-net.mdx new file mode 100644 index 00000000000..ea65734ba78 --- /dev/null +++ b/src/content/docs/apm/agents/net-agent/other-features/supportability-metrics-net.mdx @@ -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'; + + \ No newline at end of file diff --git a/src/content/docs/apm/supportability-metrics/c-sdk-supportability-metrics.mdx b/src/content/docs/apm/supportability-metrics/c-sdk-supportability-metrics.mdx new file mode 100644 index 00000000000..49b1800d382 --- /dev/null +++ b/src/content/docs/apm/supportability-metrics/c-sdk-supportability-metrics.mdx @@ -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 +--- + + + This documentation is currently under development. For immediate assistance with C SDK supportability metrics, please contact [New Relic Support](https://support.newrelic.com/). + + +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 diff --git a/src/content/docs/apm/supportability-metrics/go-supportability-metrics.mdx b/src/content/docs/apm/supportability-metrics/go-supportability-metrics.mdx new file mode 100644 index 00000000000..a6ce950f98f --- /dev/null +++ b/src/content/docs/apm/supportability-metrics/go-supportability-metrics.mdx @@ -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 +--- + + + This documentation is currently under development. For immediate assistance with Go agent supportability metrics, please contact [New Relic Support](https://support.newrelic.com/). + + +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 diff --git a/src/content/docs/apm/supportability-metrics/introduction.mdx b/src/content/docs/apm/supportability-metrics/introduction.mdx new file mode 100644 index 00000000000..12840e0886f --- /dev/null +++ b/src/content/docs/apm/supportability-metrics/introduction.mdx @@ -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. + + + 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. + + +## 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: + + + + ```sql + SELECT uniques(metricName) + FROM Metric + WHERE metricName LIKE 'Supportability/%' + SINCE 1 day ago + LIMIT MAX + ``` + + + + ```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 + ``` + + + + ```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` + ``` + + + +## 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: + + + + .NET agent metrics + + + + Java agent metrics + + + + + + Node.js agent metrics + + + + Python agent metrics + + + + + + Ruby agent metrics + + + + PHP agent metrics + + + + + + Go agent metrics + + + + C SDK metrics + + + +## 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 \ No newline at end of file diff --git a/src/content/docs/apm/supportability-metrics/java-agent-supportability-metrics.mdx b/src/content/docs/apm/supportability-metrics/java-agent-supportability-metrics.mdx new file mode 100644 index 00000000000..ea4d21e76bb --- /dev/null +++ b/src/content/docs/apm/supportability-metrics/java-agent-supportability-metrics.mdx @@ -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 +--- + + + This documentation is currently under development. For immediate assistance with Java agent supportability metrics, please contact [New Relic Support](https://support.newrelic.com/). + + +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 \ No newline at end of file diff --git a/src/content/docs/apm/supportability-metrics/net-agent-supportability-metrics.mdx b/src/content/docs/apm/supportability-metrics/net-agent-supportability-metrics.mdx new file mode 100644 index 00000000000..888406b1d4a --- /dev/null +++ b/src/content/docs/apm/supportability-metrics/net-agent-supportability-metrics.mdx @@ -0,0 +1,294 @@ +--- +title: ".NET agent supportability metrics" +tags: + - APM + - Supportability metrics + - 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/agents/net-agent/other-features/supportability-metrics-net +freshnessValidatedDate: never +--- + +Supportability metrics help you understand how your .NET agent is performing and identify potential issues with your application monitoring. These metrics provide valuable insights into agent behavior, feature adoption, and configuration effectiveness. + + + 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. + + +## What are supportability metrics? [#what-are-supportability-metrics] + +Supportability metrics are specialized metrics that the .NET agent automatically collects about its 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 + +All supportability metrics use the `Supportability/` prefix in their metric names, making them easy to identify and query. + +## Distributed tracing metrics [#distributed-tracing-metrics] + +These metrics help you troubleshoot distributed tracing configuration and connectivity issues between your services. + +### NewRelic payload metrics + +| Metric name | Description | When to investigate | +|-------------|-------------|---------------------| +| `Supportability/DistributedTrace/CreatePayload/Success` | Successfully created tracing payload for outbound requests | Low values may indicate configuration issues | +| `Supportability/DistributedTrace/CreatePayload/Exception` | Failed to create tracing payload due to errors | Any non-zero values indicate problems | +| `Supportability/DistributedTrace/AcceptPayload/Success` | Successfully processed incoming tracing payload | Should match inbound request volume | +| `Supportability/DistributedTrace/AcceptPayload/Exception` | Failed to process incoming tracing payload | Investigate non-zero values for configuration issues | + +### W3C TraceContext metrics + +| Metric name | Description | When to investigate | +|-------------|-------------|---------------------| +| `Supportability/TraceContext/Create/Success` | Created W3C-compliant trace headers | Should match outbound request volume | +| `Supportability/TraceContext/Accept/Success` | Processed incoming W3C trace headers | Should match inbound traced request volume | +| `Supportability/TraceContext/Accept/Exception` | Failed to process W3C headers | Non-zero values indicate header format issues | +| `Supportability/TraceContext/TraceParent/Parse/Exception` | Invalid traceparent header format received | Check upstream services for proper W3C implementation | + + + Compare success metrics with your actual request volume. Low ratios may indicate that not all services in your trace have distributed tracing enabled. + + +## Agent collector communication metrics [#collector-metrics] + +These metrics monitor communication between your agent and New Relic's data collection service. + +### Connection and retry metrics + +| Metric name | Description | What it means | +|-------------|-------------|---------------| +| `Supportability/Agent/Collector/connect/Success` | Successful connections to New Relic | Should show regular successful connections | +| `Supportability/Agent/Collector/connect/Exception` | Failed connection attempts | High values indicate network or configuration issues | +| `Supportability/Agent/Collector/DataSent` | Bytes sent to New Relic per request type | Monitor for data usage tracking | +| `Supportability/Agent/Collector/MaxPayloadSizeLimit` | Payload size limit reached | Indicates data is being dropped due to size limits | + +### Data harvest metrics + +| Metric name | Description | When to investigate | +|-------------|-------------|---------------------| +| `Supportability/EventHarvest/ReportPeriod` | How often data is sent to New Relic | Validate against your configuration settings | +| `Supportability/EventHarvest/HarvestLimitReached` | Data reservoir reached capacity | High values indicate you need to adjust harvest limits | +| `Supportability/AnalyticsEvents/TotalEventsSeen` | Total transaction events collected | Compare with TotalEventsSent to check for data loss | +| `Supportability/AnalyticsEvents/TotalEventsSent` | Total transaction events transmitted | Should be close to TotalEventsSeen | + + + + If you see these values in your metrics: + + * `Supportability/AnalyticsEvents/TotalEventsSeen`: 10,000 + * `Supportability/AnalyticsEvents/TotalEventsSent`: 2,000 + + This indicates your agent collected 10,000 transaction events but only sent 2,000 to New Relic. The difference (8,000 events) was dropped due to reservoir size limits. Consider increasing your `analyticsEvents.maximumSamplesStored` configuration. + + + +## Application logging metrics [#logging-metrics] + +Monitor the performance and configuration of New Relic's application logging features. + +### Log forwarding metrics + +| Metric name | Description | When to investigate | +|-------------|-------------|---------------------| +| `Supportability/Logging/Forwarding/Sent` | Log messages successfully forwarded to New Relic | Should match your application's log volume | +| `Supportability/Logging/Forwarding/Seen` | Total log messages processed by agent | Compare with Sent to identify dropped logs | +| `Supportability/Logging/Forwarding/Dropped` | Log messages dropped before forwarding | Non-zero values indicate filtering or capacity issues | + +### Log decoration metrics + +| Metric name | Description | What it indicates | +|-------------|-------------|------------------| +| `Supportability/Logging/LocalDecorating/DotNET/enabled` | Local log decoration is active | Confirms linking metadata is being added to logs | +| `Supportability/Logging/LocalDecorating/DotNET/disabled` | Local log decoration is disabled | Check configuration if you expect log linking | + +## Performance and instrumentation metrics [#performance-metrics] + +These metrics help you understand agent overhead and instrumentation effectiveness. + +### Agent timing metrics + +| Metric name | Description | Performance impact | +|-------------|-------------|-------------------| +| `Supportability/AgentTiming/Bootstrap` | Time spent initializing the agent | High values may indicate startup delays | +| `Supportability/AgentTiming/Transaction/Create` | Time to create new transactions | Monitor for performance overhead | +| `Supportability/AgentTiming/SqlParsing` | Time spent parsing SQL statements | High values may affect database query performance | + +### Instrumentation metrics + +| Metric name | Description | What to monitor | +|-------------|-------------|-----------------| +| `Supportability/Library/[LibraryName]/[Version]` | Successfully instrumented library versions | Validates that expected frameworks are being monitored | +| `Supportability/WrapperShutdown/[InstrumentationName]` | Instrumentation disabled due to errors | Non-zero values indicate problematic instrumentation | + + + When `WrapperShutdown` metrics appear, the agent has automatically disabled problematic instrumentation to protect your application performance. Review agent logs for specific error details. + + +## Environment and configuration metrics [#environment-metrics] + +Understand your application's runtime environment and agent configuration. + +### Runtime information + +| Metric name | Description | Use case | +|-------------|-------------|----------| +| `Supportability/AgentVersion/[Version]` | Agent version in use | Validate agent updates and version consistency | +| `Supportability/Dotnet/NetFramework/[Version]` | .NET Framework version | Environment validation and compatibility checking | +| `Supportability/Dotnet/NetCore/[Version]` | .NET Core/.NET version | Runtime environment validation | +| `Supportability/OS/Linux` | Running on Linux (value: 1) or Windows (value: 0) | Platform-specific troubleshooting | + +### Installation and configuration + +| Metric name | Description | Configuration insight | +|-------------|-------------|---------------------| +| `Supportability/Dotnet/InstallType/[Type]` | Installation method used | Validate deployment strategy | +| `Supportability/utilization/aws` | Running in AWS environment | Cloud platform identification | +| `Supportability/utilization/azure` | Running in Azure environment | Cloud platform identification | +| `Supportability/utilization/gcp` | Running in Google Cloud | Cloud platform identification | +| `Supportability/utilization/docker` | Running in Docker container | Containerization detection | +| `Supportability/utilization/kubernetes` | Running in Kubernetes cluster | Orchestration platform detection | + +## API usage metrics [#api-usage-metrics] + +Track which New Relic .NET agent API methods your application is using. + +| Metric name | Description | Usage insights | +|-------------|-------------|---------------| +| `Supportability/ApiInvocation/AddCustomAttribute` | Custom attribute API calls | Monitor custom attribute usage patterns | +| `Supportability/ApiInvocation/NoticeError` | Error recording API calls | Track manual error reporting frequency | +| `Supportability/ApiInvocation/SetTransactionName` | Transaction naming API calls | Validate custom transaction naming | +| `Supportability/ApiInvocation/StartTransaction` | Manual transaction creation | Monitor custom transaction patterns | + +## Querying supportability metrics [#querying-metrics] + +Use these NRQL queries to analyze your supportability metrics: + + + + ```sql + SELECT + count(*) as 'Total Requests', + sum(Supportability/TraceContext/Create/Success) as 'Successful Outbound Traces', + sum(Supportability/TraceContext/Accept/Success) as 'Successful Inbound Traces', + sum(Supportability/TraceContext/Accept/Exception) as 'Failed Inbound Traces' + FROM Metric + WHERE metricName LIKE 'Supportability/TraceContext%' + SINCE 1 hour ago + TIMESERIES + ``` + + + + ```sql + SELECT + sum(Supportability/AnalyticsEvents/TotalEventsSeen) as 'Events Collected', + sum(Supportability/AnalyticsEvents/TotalEventsSent) as 'Events Sent', + (sum(Supportability/AnalyticsEvents/TotalEventsSeen) - sum(Supportability/AnalyticsEvents/TotalEventsSent)) as 'Events Dropped' + FROM Metric + WHERE metricName LIKE 'Supportability/AnalyticsEvents%' + SINCE 1 day ago + ``` + + + + ```sql + SELECT + average(Supportability/AgentTiming/Bootstrap) as 'Avg Bootstrap Time (ms)', + average(Supportability/AgentTiming/Transaction/Create) as 'Avg Transaction Creation Time (ms)', + percentile(Supportability/AgentTiming/SqlParsing, 95) as '95th Percentile SQL Parse Time (ms)' + FROM Metric + WHERE metricName LIKE 'Supportability/AgentTiming%' + SINCE 1 hour ago + TIMESERIES + ``` + + + + ```sql + SELECT + uniques(metricName) as 'Environment Details' + FROM Metric + WHERE metricName LIKE 'Supportability/Dotnet%' + OR metricName LIKE 'Supportability/utilization%' + OR metricName LIKE 'Supportability/AgentVersion%' + SINCE 1 day ago + ``` + + + +## Troubleshooting with supportability metrics [#troubleshooting] + +### Common issues and solutions + +| Problem | Metrics to check | Solution | +|---------|------------------|----------| +| Missing distributed traces | `Supportability/TraceContext/Create/Success` and `Accept/Success` | Verify distributed tracing is enabled on all services | +| High data costs | `Supportability/Agent/Collector/DataSent` | Review data harvest configuration and sampling rates | +| Performance degradation | `Supportability/AgentTiming/*` metrics | Check for high timing values and optimize configuration | +| Transaction events missing | Compare `TotalEventsSeen` vs `TotalEventsSent` | Increase analytics events reservoir size | +| Log data not appearing | `Supportability/Logging/Forwarding/*` metrics | Validate logging configuration and forwarding setup | + +### Creating alerts for supportability metrics + +Monitor critical supportability metrics with [NRQL alert conditions](/docs/alerts-applied-intelligence/new-relic-alerts/alert-conditions/create-nrql-alert-conditions/): + + + + **Alert condition**: Data loss detection + + ```sql + SELECT + (sum(Supportability/AnalyticsEvents/TotalEventsSeen) - sum(Supportability/AnalyticsEvents/TotalEventsSent)) / sum(Supportability/AnalyticsEvents/TotalEventsSeen) * 100 + FROM Metric + WHERE metricName LIKE 'Supportability/AnalyticsEvents%' + ``` + + **Threshold**: Alert when data loss exceeds 10% + + + + **Alert condition**: Collector connection failures + + ```sql + SELECT sum(Supportability/Agent/Collector/connect/Exception) + FROM Metric + WHERE metricName = 'Supportability/Agent/Collector/connect/Exception' + ``` + + **Threshold**: Alert when failures exceed 5 in 5 minutes + + + +## Next steps [#next-steps] + +* Learn more about [custom instrumentation](/docs/apm/agents/net-agent/custom-instrumentation/introduction-net-custom-instrumentation) to expand your monitoring coverage +* Explore [.NET agent configuration options](/docs/apm/agents/net-agent/configuration/net-agent-configuration) to optimize performance +* Set up [custom dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards) to visualize your supportability metrics +* Review [.NET agent troubleshooting guides](/docs/apm/agents/net-agent/troubleshooting) for additional problem-solving resources \ No newline at end of file diff --git a/src/content/docs/apm/supportability-metrics/nodejs-agent-supportability-metrics.mdx b/src/content/docs/apm/supportability-metrics/nodejs-agent-supportability-metrics.mdx new file mode 100644 index 00000000000..d20199e90e7 --- /dev/null +++ b/src/content/docs/apm/supportability-metrics/nodejs-agent-supportability-metrics.mdx @@ -0,0 +1,50 @@ +--- +title: "Node.js agent supportability metrics" +tags: + - APM + - Supportability metrics + - Node agent + - Troubleshooting + - Performance monitoring +metaDescription: "Use Node.js agent supportability metrics to troubleshoot performance issues, validate configuration, and monitor agent health in your Node.js applications." +freshnessValidatedDate: never +--- + + + This documentation is currently under development. For immediate assistance with Node.js agent supportability metrics, please contact [New Relic Support](https://support.newrelic.com/). + + +Node.js agent supportability metrics help you understand how your Node.js 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 Node.js 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 Node.js 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 Node.js agent supportability metrics: + +```sql +SELECT uniques(metricName) +FROM Metric +WHERE metricName LIKE 'Supportability/%' +AND appName LIKE '%your-nodejs-app%' +SINCE 1 day ago +LIMIT MAX +``` + +## Next steps + +* Learn more about [Node.js agent configuration](/docs/apm/agents/nodejs-agent/installation-configuration/nodejs-agent-configuration) +* Explore [Node.js agent troubleshooting guides](/docs/apm/agents/nodejs-agent/troubleshooting) +* Set up [custom dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards) to visualize your metrics \ No newline at end of file diff --git a/src/content/docs/apm/supportability-metrics/php-supportability-metrics.mdx b/src/content/docs/apm/supportability-metrics/php-supportability-metrics.mdx new file mode 100644 index 00000000000..122fd3c6486 --- /dev/null +++ b/src/content/docs/apm/supportability-metrics/php-supportability-metrics.mdx @@ -0,0 +1,27 @@ +--- +title: "PHP agent supportability metrics" +tags: + - APM + - Supportability metrics + - PHP agent + - Troubleshooting + - Performance monitoring +metaDescription: "Use PHP agent supportability metrics to troubleshoot performance issues, validate configuration, and monitor agent health in your applications." +freshnessValidatedDate: never +--- + + + This documentation is currently under development. For immediate assistance with PHP agent supportability metrics, please contact [New Relic Support](https://support.newrelic.com/). + + +PHP agent supportability metrics help you understand how your PHP 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 PHP 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 [PHP agent configuration](/docs/apm/agents/php-agent/configuration/php-agent-configuration) +* Explore [PHP agent troubleshooting guides](/docs/apm/agents/php-agent/troubleshooting) +* Set up [custom dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards) to visualize your metrics diff --git a/src/content/docs/apm/supportability-metrics/python-agent-supportability-metrics.mdx b/src/content/docs/apm/supportability-metrics/python-agent-supportability-metrics.mdx new file mode 100644 index 00000000000..bbe3f88e7d5 --- /dev/null +++ b/src/content/docs/apm/supportability-metrics/python-agent-supportability-metrics.mdx @@ -0,0 +1,27 @@ +--- +title: "Python agent supportability metrics" +tags: + - APM + - Supportability metrics + - Python agent + - Troubleshooting + - Performance monitoring +metaDescription: "Use Python agent supportability metrics to troubleshoot performance issues, validate configuration, and monitor agent health in your Python applications." +freshnessValidatedDate: never +--- + + + This documentation is currently under development. For immediate assistance with Python agent supportability metrics, please contact [New Relic Support](https://support.newrelic.com/). + + +Python agent supportability metrics help you understand how your Python 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 Python 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 [Python agent configuration](/docs/apm/agents/python-agent/configuration/python-agent-configuration) +* Explore [Python agent troubleshooting guides](/docs/apm/agents/python-agent/troubleshooting) +* Set up [custom dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards) to visualize your metrics diff --git a/src/content/docs/apm/supportability-metrics/ruby-supportability-metrics.mdx b/src/content/docs/apm/supportability-metrics/ruby-supportability-metrics.mdx new file mode 100644 index 00000000000..bd003f35551 --- /dev/null +++ b/src/content/docs/apm/supportability-metrics/ruby-supportability-metrics.mdx @@ -0,0 +1,27 @@ +--- +title: "Ruby agent supportability metrics" +tags: + - APM + - Supportability metrics + - Ruby agent + - Troubleshooting + - Performance monitoring +metaDescription: "Use Ruby agent supportability metrics to troubleshoot performance issues, validate configuration, and monitor agent health in your applications." +freshnessValidatedDate: never +--- + + + This documentation is currently under development. For immediate assistance with Ruby agent supportability metrics, please contact [New Relic Support](https://support.newrelic.com/). + + +Ruby agent supportability metrics help you understand how your Ruby 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 Ruby 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 [Ruby agent configuration](/docs/apm/agents/ruby-agent/configuration/ruby-agent-configuration) +* Explore [Ruby agent troubleshooting guides](/docs/apm/agents/ruby-agent/troubleshooting) +* Set up [custom dashboards](/docs/query-your-data/explore-query-data/dashboards/introduction-dashboards) to visualize your metrics diff --git a/src/nav/apm.yml b/src/nav/apm.yml index 44d77b8c489..d6e386ae7cc 100644 --- a/src/nav/apm.yml +++ b/src/nav/apm.yml @@ -1290,6 +1290,26 @@ pages: path: /docs/apm/agents/manage-apm-agents/troubleshooting/agent-nrintegrationerrors-appear-insights - title: Environment and services path: /docs/apm/agents/manage-apm-agents/troubleshooting/get-environment-data-about-your-apm-app + - title: Supportability metrics + pages: + - title: Introduction to supportability metrics + path: /docs/apm/supportability-metrics/introduction + - title: .NET agent supportability metrics + path: /docs/apm/supportability-metrics/net-agent-supportability-metrics + - title: Java agent supportability metrics + path: /docs/apm/supportability-metrics/java-agent-supportability-metrics + - title: Node.js agent supportability metrics + path: /docs/apm/supportability-metrics/nodejs-agent-supportability-metrics + - title: Python agent supportability metrics + path: /docs/apm/supportability-metrics/python-agent-supportability-metrics + - title: Ruby agent supportability metrics + path: /docs/apm/supportability-metrics/ruby-agent-supportability-metrics + - title: PHP agent supportability metrics + path: /docs/apm/supportability-metrics/php-agent-supportability-metrics + - title: Go agent supportability metrics + path: /docs/apm/supportability-metrics/go-agent-supportability-metrics + - title: C SDK supportability metrics + path: /docs/apm/supportability-metrics/c-sdk-supportability-metrics - title: Transactions pages: - title: What is a transaction?