Skip to content

Commit

Permalink
feat(Pixie): Add Customize ingest instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Hannah Troisi <htroisi@pixielabs.ai>
  • Loading branch information
htroisi committed Jun 23, 2022
1 parent 15a6851 commit 29d71ef
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ import pixieServiceOtelTransactions from 'images/pixie-services-otel-transaction

import pixieHybridStorage from 'images/pixie-integration-hybrid-storage.png'

import customizeIngestButton from 'images/pixie-customize-ingest-button.png'

import customizeIngest from 'images/pixie-customize-ingest.png'

<img
title="New Relic's UI pulls data from data seen in the OpenTelemetry **Transactions** tab. "
alt="Pixie data seen in the OpenTelemetry **Transactions** tab. "
Expand Down Expand Up @@ -69,4 +73,40 @@ You can configure which data is persisted in New Relic, including persisting add

### Configure which Pixie data is persisted in New Relic [#pixie-configure-storage]

Coming soon!
You can configure which Pixie telemetry data is persisted in New Relic for long-term storage:

1. [Select your Kubernetes cluster](https://one.newrelic.com/kubernetes-cluster-explorer) to navigate to the Kubernetes cluster explorer.

2. Select the **Live debugging with Pixie** tab.

3. Select the **Customize Pixie Ingest** button in the top right.

<img
title="Customize Pixie data ingest button"
alt="Customize Pixie data ingest button"
src={customizeIngestButton}
/>

<figcaption>
You can customize which Pixie telemetry data is persisted in New Relic within the **Live debugging with Pixie** tab.
</figcaption>

The New Relic Pixie integration uses Pixie’s [Plugin System](https://docs.px.dev/reference/plugins/plugin-system/) to export select Pixie telemetry data to New Relic for long-term storage. The **Customize Pixie Ingest** page contains an embedded view of Pixie’s plugin configuration page:

<img
title="Customize Pixie data ingest page"
alt="Customize Pixie data ingest page"
src={customizeIngest}
/>

<figcaption>
You can enable, disable, and add more export scripts to configure which Pixie telemetry data is ingested by New Relic.
</figcaption>

<Callout variant="important">
The **Customize Pixie Ingest** feature requires version 2.X.X+ of the New Relic Pixie integration. You may need to [upgrade your integration](https://docs.newrelic.com/docs/kubernetes-pixie/auto-telemetry-pixie/install-auto-telemetry-pixie/#upgrade) to access this feature.
</Callout>

By default, the New Relic Pixie integration includes several Pixie export scripts that are already enabled. You can choose to disable one or more of these scripts to reduce Pixie telemetry data ingest.

To export additional Pixie telemetry data to New Relic, use the `+ CREATE SCRIPT` button. These scripts are written in Pixie’s PxL language and use Pixie’s OpenTelemetry export methods. To learn how to write a PxL script to export Pixie data in the OpenTelemetry format, check out this [tutorial](https://docs.px.dev/tutorials/integrations/otel/).
Binary file added src/images/pixie-customize-ingest-button.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/images/pixie-customize-ingest.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 29d71ef

Please sign in to comment.