Skip to content

Commit

Permalink
fix(K8s): Added the caution note about the summary page
Browse files Browse the repository at this point in the history
  • Loading branch information
nbaenam committed Oct 31, 2024
1 parent 833e94d commit 82a1f95
Showing 1 changed file with 8 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ To successfully complete the steps below, you should already be familiar with Op
* `OTEL_EXPORTER_OTLP_ENDPOINT`: See [New Relic OTLP endpoint](/docs/opentelemetry/best-practices/opentelemetry-otlp/) for more info.
* `NEW_RELIC_API_KEY`: See [New Relic API keys](/docs/apis/intro-apis/new-relic-api-keys/) for more info.

* Installed the [New Relic Kubernetes integration](/install/kubernetes) in your cluster.
* Installed your [Kubernetes cluster with OpenTelemetry](/docs/kubernetes-pixie/kubernetes-integration/installation/k8s-otel/#install).

* Instrumented your applications with [OpenTelemetry](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/opentelemetry-setup/), and successfully sent data to New Relic via OpenTelemetry Protocol (OTLP).

If you have general questions about using Collectors with New Relic, see our [Introduction to OpenTelemetry Collector with New Relic](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/collector/opentelemetry-collector-intro).
If you've general questions about using Collectors with New Relic, see our [Introduction to OpenTelemetry Collector with New Relic](/docs/more-integrations/open-source-telemetry-integrations/opentelemetry/collector/opentelemetry-collector-intro).

## Configure your application to send telemetry data to the OpenTelemetry Collector [#instrument]

Expand Down Expand Up @@ -204,6 +204,11 @@ You can choose one of these options to monitor your cluster:

You should be able to verify that your configurations are working once you have successfully linked your OpenTelemetry data with your Kubernetes data.

<Callout variant="caution">
Note that the [Kubernetes summary page](/docs/apm/apm-ui-pages/monitoring/kubernetes-summary-page) works when both Kubernetes and APM are monitored either exclusively by New Relic's proprietary agents or entirely by OpenTelemetry. If there is a mix of different instrumentation providers (New Relic and OpenTelemetry), you won't see any data on this page.

Check notice on line 208 in src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/link-otel-applications-kubernetes.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/link-otel-applications-kubernetes.mdx#L208

[Microsoft.SentenceLength] Try to keep sentences short (< 30 words).
Raw output
{"message": "[Microsoft.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/link-otel-applications-kubernetes.mdx", "range": {"start": {"line": 208, "column": 3}}}, "severity": "INFO"}

Check notice on line 208 in src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/link-otel-applications-kubernetes.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/link-otel-applications-kubernetes.mdx#L208

[Microsoft.Passive] 'are monitored' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'are monitored' looks like passive voice.", "location": {"path": "src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/link-otel-applications-kubernetes.mdx", "range": {"start": {"line": 208, "column": 137}}}, "severity": "INFO"}

Check notice on line 208 in src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/link-otel-applications-kubernetes.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/link-otel-applications-kubernetes.mdx#L208

[new-relic.ComplexWords] Consider using 'only' instead of 'exclusively'.
Raw output
{"message": "[new-relic.ComplexWords] Consider using 'only' instead of 'exclusively'.", "location": {"path": "src/content/docs/kubernetes-pixie/kubernetes-integration/advanced-configuration/link-otel-applications-kubernetes.mdx", "range": {"start": {"line": 208, "column": 158}}}, "severity": "INFO"}
</Callout>


1. Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > APM & Services**</DNT> and select your application inside <DNT>**Services - OpenTelemetry**</DNT>.

2. Click <DNT>**Kubernetes**</DNT> on the left navigation pane.
Expand All @@ -216,7 +221,7 @@ You should be able to verify that your configurations are working once you have
/>

<figcaption>
Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > APM & Services > (selected app) > Kubernetes**</DNT>
Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > APM & Services > (selected app) > Kubernetes**</DNT> to see the Kubernetes summary page.
</figcaption>


Expand Down

0 comments on commit 82a1f95

Please sign in to comment.