Skip to content
2 changes: 1 addition & 1 deletion content/en/01-about-pixie/01-what-is-pixie.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Pixie was contributed by [New Relic, Inc.](https://newrelic.com/) to the [Cloud

* **Auto-telemetry**: Pixie uses eBPF to automatically collect telemetry data such as full-body requests, resource and network metrics, application profiles, and [more](/about-pixie/data-sources).

* **In-cluster edge compute**: Pixie collects, stores and queries all telemetry data [locally in the cluster](/about-pixie/faq#data-collection-where-does-pixie-store-its-data). Pixie uses less than 5% of cluster CPU, and in most cases less than 2%.
* **In-cluster edge compute**: Pixie collects, stores and queries all telemetry data [locally in the cluster](/about-pixie/faq/#data-collection-where-does-pixie-store-its-data). Pixie uses less than 5% of cluster CPU, and in most cases less than 2%.

* **Scriptability**: [PxL](/reference/pxl/), Pixie’s flexible Pythonic query language, can be used across Pixie’s UI, CLI, and client APIs. Pixie provides a set of [community scripts](https://github.com/pixie-io/pixie/tree/main/src/pxl_scripts) for common [use cases](/tutorials/pixie-101).

Expand Down
6 changes: 3 additions & 3 deletions content/en/01-about-pixie/05-faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metaDescription: "Commonly asked questions about Pixie."
order: 5
---

### General
**General**
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I needed to make this body text (and not H3) because there's a weird bug with our docs.px.dev website where it doesn't like the fact that these H3 don't have an H2 parent. h-links for H3 are of the format #-H2-H3 and these links get random H2 parents that can be brokenlinks.


- [What is Pixie?](#general-what-is-pixie)
- [Who created Pixie?](#general-who-created-pixie)
Expand All @@ -14,7 +14,7 @@ order: 5
- [Can I completely self-host Pixie?](#general-can-i-completely-self-host-pixie)
- [Is there a hosted cloud offering?](#general-does-pixie-offer-a-hosted-cloud-offering)

### Data Collection
**Data Collection**

- [Where does Pixie store its data?](#data-collection-where-does-pixie-store-its-data)
- [How much data does Pixie store?](#data-collection-how-much-data-does-pixie-store)
Expand All @@ -28,7 +28,7 @@ order: 5
- [What is the performance impact?](#data-collection-what-is-the-performance-impact)
- [Which languages are supported for continuous profiling?](#data-collection-which-languages-are-supported-for-continuous-profiling)

### How do I…
**How do I…**

- [How do I export data from the Pixie platform? Import data?](#how-do-i...-how-do-i-export-data-from-the-pixie-platform-import-data)
- [How do I share a Pixie dashboard with others?](#how-do-i...-how-do-i-share-a-pixie-dashboard-with-others)
Expand Down
2 changes: 1 addition & 1 deletion content/en/01-about-pixie/06-troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Pixie has a minimum 1GiB memory requirement per node. The default deployment is

### Why is Pixie being OOMKilled?

This happens when Pixie is using more memory than the limit. Try [increasing the limit](/reference/admin/deploy-options/#configuring-pixie's-memory-usage-setting-the-memory-limit), or [reducing the amount of data stored](/reference/admin/deploy-options/#configuring-pixie's-memory-usage-setting-the-data-table-storage-memory-limit) in the table store. The amount of memory needed for Pixie depends on the application, but a minimum of [1Gi](/installing-pixie/requirements/#memory) is required. However, for most clusters we recommend 2Gi. For more information, see the [Tuning Memory Usage](/reference/admin/tuning-mem-usage/) page.
This happens when Pixie is using more memory than the limit. Try [increasing the limit](/reference/admin/deploy-options/#configure-pixie-memory-usage-setting-the-memory-limit), or [reducing the amount of data stored](/reference/admin/deploy-options/#configure-pixie-memory-usage-setting-the-data-table-storage-memory-limit) in the table store. The amount of memory needed for Pixie depends on the application, but a minimum of [1Gi](/installing-pixie/requirements/#memory) is required. However, for most clusters we recommend 2Gi. For more information, see the [Tuning Memory Usage](/reference/admin/tuning-mem-usage/) page.

### Troubleshooting Pixie tracepoint scripts

Expand Down
4 changes: 2 additions & 2 deletions content/en/02-installing-pixie/01-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ For local development, we recommend using Minikube with a VM driver (`kvm2` on L

## Operating System

Pixie runs on Linux nodes only. You can configure Pixie to [deploy to a subset of the nodes](/reference/admin/deploy-options#deploy-pixie-to-a-subset-of-nodes) in your cluster.
Pixie runs on Linux nodes only. You can configure Pixie to [deploy to a subset of the nodes](/reference/admin/deploy-options/#deploy-pixie-to-a-subset-of-nodes) in your cluster.

| | Support | Version |
| :------ | :------------- | :---------------- |
Expand Down Expand Up @@ -99,4 +99,4 @@ Pixie deploys its PEMs as a DaemonSet on your cluster in order to collect and st

Pixie's [Vizier](/reference/architecture/#vizier) module sends outgoing HTTPS/2 requests to Pixie's [Cloud](/reference/architecture/#cloud) on port `443`.

Your cluster's telemetry data flows through Pixie's Cloud via a reverse proxy as encrypted traffic without any persistence. This allows users to access data without being in the same VPC/network as the cluster. Pixie offers [end-to-end encryption](/about-pixie/faq#data-collection-how-does-pixie-secure-its-data) for telemetry data in flight.
Your cluster's telemetry data flows through Pixie's Cloud via a reverse proxy as encrypted traffic without any persistence. This allows users to access data without being in the same VPC/network as the cluster. Pixie offers [end-to-end encryption](/about-pixie/faq/#data-collection-how-does-pixie-secure-its-data) for telemetry data in flight.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ There are multiple hosting options for Pixie.
- [Community Cloud for Pixie Guide (easiest)](/installing-pixie/install-guides/community-cloud-for-pixie)
- [Self-Hosted Pixie](/installing-pixie/install-guides/self-hosted-pixie)

Pixie is a hybrid system, with a cloud component (Pixie Cloud) and an in-cluster component for data persistence and storage (Vizier). See [Architecture](/about-pixie/what-is-pixie#architecture) for more details.
Pixie is a hybrid system, with a cloud component (Pixie Cloud) and an in-cluster component for data persistence and storage (Vizier). See [Architecture](/about-pixie/what-is-pixie/#architecture) for more details.

While Vizier will always be deployed directly onto your Kubernetes cluster, there are multiple options for Pixie Cloud.

Expand Down
2 changes: 1 addition & 1 deletion content/en/03-using-pixie/02-using-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ px live -f <script.pxl> # Use Pixie's Live CLI to run the pxl script with the p

### End-to-End Encryption

Pixie offers end-to-end encryption for telemetry data requested by the CLI. For more information, see the [FAQ](/about-pixie/faq#how-does-pixie-secure-its-data).
Pixie offers end-to-end encryption for telemetry data requested by the CLI. For more information, see the [FAQ](/about-pixie/faq/#data-collection-how-does-pixie-secure-its-data).

Encryption is controlled by the `--e2e_encryption` flag during script execution. Enabling E2E encryption adds some overhead to encrypt the results on the Vizier side and decrypt it on the CLI side.

Expand Down
2 changes: 1 addition & 1 deletion content/en/03-using-pixie/03-api-quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,6 @@ func (s *tableMux) AcceptTable(ctx context.Context, metadata types.TableMetadata

## End-to-End Encryption

Pixie offers end-to-end encryption for telemetry data requested by the API. For more information, see the [FAQ](/about-pixie/faq#how-does-pixie-secure-its-data).
Pixie offers end-to-end encryption for telemetry data requested by the API. For more information, see the [FAQ](/about-pixie/faq/#data-collection-how-does-pixie-secure-its-data).

Encryption is controlled by a flag during client creation. For additional info, see the [Go](https://github.com/pixie-io/pixie/blob/main/src/api/go/pxapi/examples/encryption_example/example.go#L77) or [Python](https://github.com/pixie-io/pixie/blob/main/src/api/python/examples/script_with_single_table.py#L35) encryption examples.
2 changes: 1 addition & 1 deletion content/en/04-tutorials/03-integrations/02-grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ This plugin uses the Pixie Language ([PxL](/reference/pxl)) to query telemetry d

The above PxL query outputs a table of timeseries data showing overall HTTP request throughput. Request throughput is calculated by counting the number HTTP requests that Pixie automatically traces in your cluster.

This query uses the `__time_from` and `__interval` macros to add dashboard context to the query. See the full [list of macros](/reference/plugins/grafana/#macros) supported by this plugin.
This query uses the `__time_from` and `__interval` macros to add dashboard context to the query. See the full [list of macros](/reference/plugins/grafana/#usage-macros) supported by this plugin.

2. On the Panel tab, under the **Visualization** drop-down menu, select **Time series**.

Expand Down
2 changes: 1 addition & 1 deletion content/en/04-tutorials/03-integrations/03-otel.md
Original file line number Diff line number Diff line change
Expand Up @@ -284,4 +284,4 @@ Congrats! You're now exporting Pixie data to an OTel collector.

## Troubleshooting

Having problems? Check out the [Pixie Plugin Troubleshooting](/about-pixie/troubleshooting/#troubleshooting-troubleshooting-a-pixie-plugin) guide.
Having problems? Check out the [Pixie Plugin Troubleshooting](/about-pixie/troubleshooting/#troubleshooting-a-pixie-plugin) guide.
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Pixie can deploy [bpftrace](https://github.com/iovisor/bpftrace) programs to you

## Background

Most of the data in Pixie's no-instrumentation monitoring platform is collected by the Pixie Edge Modules ([PEMs](/about-pixie/what-is-pixie#architecture)), which are deployed as a daemonset onto every node in your cluster. These PEMs use eBPF based tracing to collect network transactions without any code changes.
Most of the data in Pixie's no-instrumentation monitoring platform is collected by the Pixie Edge Modules ([PEMs](/about-pixie/what-is-pixie/#architecture)), which are deployed as a daemonset onto every node in your cluster. These PEMs use eBPF based tracing to collect network transactions without any code changes.

One increasingly popular way to write eBPF programs is to use [bpftrace](https://github.com/iovisor/bpftrace), an open source high-level tracing language for Linux. bpftrace provides a simplified front-end language that makes it easier to write BPF programs when compared to frameworks such as `BCC`. Many bpftrace programs are written as one-liners or stand-alone scripts.

Expand Down
6 changes: 3 additions & 3 deletions content/en/05-reference/01-admin/02-data-transfer-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ redirect_from:
- /installing-pixie/data-transfer-mode
---

Pixie stores the data it collects in-memory on the nodes in your cluster. For more information, see the [FAQ](/about-pixie/faq#where-does-pixie-store-its-data).
Pixie stores the data it collects in-memory on the nodes in your cluster. For more information, see the [FAQ](/about-pixie/faq/#data-collection-where-does-pixie-store-its-data).

Pixie supports two modes for accessing this data by the Live UI.

## Data Passthrough Mode (Default)

In data passthrough mode, your cluster's data flows through Pixie's control cloud via a reverse proxy as encrypted traffic without any persistence. This allows users to access data without being in the same VPC/network as the cluster.

Pixie offers [end-to-end encryption](/about-pixie/faq#how-does-pixie-secure-its-data) for telemetry data in flight.
Pixie offers [end-to-end encryption](/about-pixie/faq/#data-collection-how-does-pixie-secure-its-data) for telemetry data in flight.

When enabled, the Live UI [Admin Page](https://work.withpixie.ai/admin) will show your cluster's **Mode** as `Passthrough`.

Expand All @@ -31,7 +31,7 @@ When enabled, the Live UI [Admin Page](https://work.withpixie.ai/admin) will sho
We will be removing support for Direct Mode on March 31, 2022. Existing clusters with Direct Mode enabled may continue using Direct Mode until support is discontinued, at which time the cluster will automatically be switched to Passthrough Mode. To manually switch a cluster from Direct to Passthrough mode, see the "Steps to Disable" in the section below. New and existing clusters without Direct Mode enabled will be prevented from enabling Direct Mode moving forward.
</Alert>

In Data Isolation Mode, the browser directly proxies into Pixie's Vizier Module and no customer data is transferred to Pixie's Control Cloud. Communication to Pixie's Control Cloud is limited to account and Kubernetes control data. See the [FAQ](/about-pixie/faq#how-does-pixie-secure-its-data) and [Architecture Diagram](/about-pixie/what-is-pixie#architecture) for more details.
In Data Isolation Mode, the browser directly proxies into Pixie's Vizier Module and no customer data is transferred to Pixie's Control Cloud. Communication to Pixie's Control Cloud is limited to account and Kubernetes control data. See the [FAQ](/about-pixie/faq/#data-collection-how-does-pixie-secure-its-data) and [Architecture Diagram](/about-pixie/what-is-pixie/#architecture) for more details.

<Alert variant="outlined" severity="warning">
Note that you must be behind your cluster's firewall to see data in the Live UI when Data Isolation Mode is enabled.
Expand Down
10 changes: 5 additions & 5 deletions content/en/05-reference/01-admin/04-deploy-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Pixie offers the following deploy options:
- [Label Pixie's resources](#labeling-pixie's-resources)
- [Deploy to a subset of nodes](#deploy-pixie-to-a-subset-of-nodes)
- [Provide a custom cluster name](#providing-a-custom-cluster-name)
- [Configure Pixie's memory usage](#configuring-pixie's-memory-usage)
- [Configure Pixie's memory usage](#configure-pixie-memory-usage)
- [Set the data access mode](#setting-the-data-access-mode)

To see the full set of deploy options, install the [Pixie CLI](/installing-pixie/install-schemes/cli/) and run `px deploy --help`.
Expand Down Expand Up @@ -94,13 +94,13 @@ To provide a custom cluster name when deploying with [Helm](/installing-pixie/in
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --set clusterName=<CLUSTER_NAME> --namespace pl --create-namespace
```

## Configuring Pixie's memory usage
## Configure Pixie memory usage

When deploying Pixie, you have three options for configuring PEM memory usage:

- [Set PEM pod memory limit](#configuring-pixie's-memory-usage-setting-the-memory-limit)
- [Set PEM pod memory request](#configuring-pixie's-memory-usage-setting-the-memory-request)
- [Set data table storage limit](#configuring-pixie's-memory-usage-setting-the-data-table-storage-memory-limit)
- [Set PEM pod memory limit](#configure-pixie-memory-usage-setting-the-memory-limit)
- [Set PEM pod memory request](#configure-pixie-memory-usage-setting-the-memory-request)
- [Set data table storage limit](#configure-pixie-memory-usage-setting-the-data-table-storage-memory-limit)

For more information about these options, please refer to the [Tuning Memory Usage](/reference/admin/tuning-mem-usage/) page.

Expand Down
Loading