You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/01-about-pixie/05-faq.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,11 +68,11 @@ Yes. Pixie Community Cloud is a hosted version of Pixie. Pixie stores all data o
68
68
69
69
Pixie stores the data it collects in-memory on the nodes in your cluster; no data is sent to a centralized backend outside of the cluster. This is true for both self-hosted Pixie and [Pixie Community Cloud](#general-does-pixie-offer-a-hosted-cloud-offering).
70
70
71
-
Pixie has a [1GiB memory requirement](/installing-pixie/requirements/#memory) per node. After installing Pixie, it is normal to see a temporary increase in memory usage of the `vizier-pem` pods as they begin to fill their data tables.
71
+
Pixie has a [1GiB memory requirement](/installing-pixie/requirements/#memory) per node. After installing Pixie, it is normal to see a temporary increase in memory usage of the `vizier-pem` pods as they begin to fill their [data tables](/reference/datatables/).
72
72
73
73
### How much data does Pixie store?
74
74
75
-
Retention time depends on the level of traffic in your cluster, but will generally be on the order of hours. Each data table in Pixie (e.g. `http_events`) has its own maximum size. These tables collect data until the maximum size is reached, and then begin dropping the oldest data.
75
+
Retention time depends on the level of traffic in your cluster, but will generally be on the order of hours. Each [data table](/reference/datatables/) in Pixie (e.g. `http_events`) has its own maximum size. These tables collect data until the maximum size is reached, and then begin dropping the oldest data.
76
76
77
77
Pixie's [Plugin System](/reference/plugins/plugin-system) integrates with other tools to for long-term retention. Other third-party observability tools (such as [New Relic’s integration](https://newrelic.com/platform/kubernetes-pixie)) may also provide this capability.
Copy file name to clipboardExpand all lines: content/en/01-about-pixie/06-troubleshooting.md
+8-1Lines changed: 8 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,6 +22,7 @@ This page describes how to troubleshoot Pixie. We frequently answer questions on
22
22
-[Why can’t I see data?](#troubleshooting-operation-why-can't-i-see-data)
23
23
-[Why can’t I see application profiles / flamegraphs for my pod / node?](#troubleshooting-operation-why-can't-i-see-application-profiles-flamegraphs-for-my-pod-node)
24
24
-[Why is the vizier-pem pod’s memory increasing?](#troubleshooting-operation-why-is-the-vizier-pem-pod's-memory-increasing)
25
+
-[Why is Pixie being OOMKilled?](#troubleshooting-operation-why-is-pixie-being-oomkilled)
@@ -113,7 +114,13 @@ Pixie's [continuous profiler](/tutorials/pixie-101/profiler/) currently supports
113
114
114
115
This is expected behavior. Pixie stores the data it collects in-memory on the nodes in your cluster; data is not sent to any centralized backend cloud outside of the cluster. So what you are observing is simply the data that it is collecting.
115
116
116
-
Pixie has a minimum 1GiB memory requirement per node. The default deployment is 2GiB of memory. This limit can be configured with the `--pem_memory_limit` flag when deploying Pixie. Using a value less than 1GiB is not currently recommended.
117
+
When Pixie is first deployed, you can expect to see an increase in memory utilization over time. This is because the temporary data store will go from storing 0B of data to reaching its cap of 1.25G of data (in the default deployment). Once this cap is hit, old data is expired and the memory utilization shouldn’t increase anymore.
118
+
119
+
Pixie has a minimum 1GiB memory requirement per node. The default deployment is 2GiB of memory. To learn how to configure Pixie's memory usage, see the [Tuning Memory Usage](/reference/admin/tuning-mem-usage/) page.
120
+
121
+
### Why is Pixie being OOMKilled?
122
+
123
+
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.
| 1GiB | To accommodate application pods, 4GiB+ total per node is recommended. |
52
+
| 1GiB | To accommodate application pods, we recommend using no more than 25% of the nodes' total memory for Pixie. |
53
+
54
+
Pixie deploys its PEMs as a DaemonSet on your cluster in order to collect and store telemetry data. The default memory limit is 2Gi per PEM. The lowest recommended value is 1Gi per PEM. For more information on how to configure Pixie's memory usage, see the [Tuning Memory Usage](/reference/admin/tuning-mem-usage/) page.
When deploying Pixie using the CLI, you have the option of adding one or more custom [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to the K8s objects deployed by Pixie.
-[Set the data access mode](#setting-the-data-access-mode)
13
17
14
-
```bash
15
-
# Deploy the Pixie Platform in your K8s cluster and give the deployed objects label(s)
16
-
px deploy --labels=key1=value1,key2=value2
18
+
To see the full set of deploy options, install the [Pixie CLI](/installing-pixie/install-schemes/cli/) and run `px deploy --help`.
19
+
20
+
## Annotating Pixie's resources
21
+
22
+
When deploying Pixie, you have the option of adding one or more custom [annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/) to the Kubernetes objects deployed by Pixie.
23
+
24
+
To annotate Pixie's resources when deploying with the [Pixie CLI](/installing-pixie/install-schemes/cli/), use the `--annotations` flag:
25
+
26
+
```bash
27
+
px deploy --annotations=key1=value1,key2=value2
28
+
```
17
29
18
-
# Example deployment with labeling:
19
-
px deploy --labels=application=pixie
30
+
To annotate Pixie's resources when deploying with [Helm](/installing-pixie/install-schemes/helm/), use the `annotations` field:
Certain labels are reserved for internal use by Pixie. The following are reserved label strings that may _**not be**_ used:
36
+
## Labeling Pixie's resources
37
+
38
+
When deploying Pixie, you have the option of adding one or more custom [labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) to the Kubernetes objects deployed by Pixie. Certain labels are reserved for internal use by Pixie. The following are reserved label strings that may _**not be**_ used:
23
39
24
40
-`"vizier-bootstrap"`
25
41
-`“component"`
26
42
-`“vizier-updater-dep"`
27
43
-`“app"`
28
44
29
-
## PEM Memory Usage
45
+
To label Pixie's resources when deploying with the [Pixie CLI](/installing-pixie/install-schemes/cli/), use the `--labels` flag:
30
46
31
-
Pixie deploys its PEMs as a DaemonSet on your cluster in order to collect and store telemetry data. The default memory limit is 2Gi per PEM. The lowest recommended value is [1Gi](/installing-pixie/requirements/#memory) per PEM. You have the option to configure this value via the `--pem_memory_limit` flag in the CLI/YAML (`--set pemMemoryLimit=<limit>` in Helm).
47
+
```bash
48
+
px deploy --labels=key1=value1,key2=value2
49
+
```
32
50
33
-
## Data Access
51
+
To label Pixie's resources when deploying with [Helm](/installing-pixie/install-schemes/helm/), use the `labels` field:
34
52
35
-
You can configure Pixie's data access mode in order to control what data can be displayed when executing a script.
1.`Full` (default): The user has full data access, and Pixie does not redact any collected data from the user during script execution.
39
-
2.`Restricted`: The user has restricted data access. Pixie will redact all columns that may potentially contain sensitive data (e.g. request/response bodies and headers). All rows in the column will be redacted, regardless of whether they do or do not actually contain PII. Metadata about these columns, such as length, will still be queryable.
57
+
## Providing a custom cluster name
40
58
41
-
### CLI/YAML Install
59
+
When deploying Pixie, you have the option of providing a custom cluster name. If you do not provide a cluster name, the name will be taken from the current kubeconfig.
42
60
43
-
You may specify the desired data access mode using the `--data_access` flag. If no mode is specified, the deploy assumes `Full` as default.
61
+
To provide a custom cluster name when deploying with the [Pixie CLI](/installing-pixie/install-schemes/cli/), use the `--cluster_name` flag:
44
62
63
+
```bash
64
+
# Deploy Pixie in your K8s cluster and use the provided name for the cluster.
65
+
px deploy --cluster_name=<CLUSTER_NAME>
45
66
```
46
-
px deploy --data_access=(Full|Restricted)
67
+
68
+
To provide a custom cluster name when deploying with [Helm](/installing-pixie/install-schemes/helm/), use the `clusterName` field:
When deploying Pixie, you have three options for configuring PEM memory usage:
77
+
78
+
-[Set PEM pod memory limit](#configuring-pixie's-memory-usage-setting-the-memory-limit)
79
+
-[Set PEM pod memory request](#configuring-pixie's-memory-usage-setting-the-memory-request)
80
+
-[Set data table storage limit](#configuring-pixie's-memory-usage-setting-the-data-table-storage-memory-limit)
81
+
82
+
For more information about these options, please refer to the [Tuning Memory Usage](/reference/admin/tuning-mem-usage/) page.
83
+
84
+
### Setting the memory limit
85
+
86
+
The default memory limit is 2Gi per PEM. The lowest recommended value is [1Gi](/installing-pixie/requirements/#memory) per PEM. 1Gi is not a suitable limit for a cluster with high throughput, but it is suitable for a small cluster with limited resources.
50
87
51
-
You may specify the desired data access mode using the `dataAccess` field.
88
+
To set Pixie's memory limit when deploying with the [Pixie CLI](/installing-pixie/install-schemes/cli/), use the `--pem_memory_limit` flag:
52
89
90
+
```bash
91
+
px deploy --pem_memory_limit=1Gi
92
+
```
93
+
94
+
To set Pixie's memory limit when deploying with [Helm](/installing-pixie/install-schemes/helm/), use the `pemMemoryLimit` field:
By default, the PEM's memory request will be the same as the limit. When deploying Pixie, you can specify a different memory [request](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits) than limit. This flag is useful for clusters in which the PEM pods are pending because there is not enough memory for them to be scheduled on the node.
103
+
104
+
<Alertvariant="outlined"severity="info">Please note that PEM memory request must be less than or equal to the PEM memory limit.</Alert>
105
+
106
+
To set Pixie's memory request when deploying with the [Pixie CLI](/installing-pixie/install-schemes/cli/), use the `--pem_memory_request` flag:
107
+
108
+
```bash
109
+
px deploy --pem_memory_request=1Gi
110
+
```
111
+
112
+
To set Pixie's memory request when deploying with [Helm](/installing-pixie/install-schemes/helm/), use the `pemMemoryRequest` field:
This is an advanced option that most developers shouldn't need. For more discussion see the [Tuning Memory Usage](/reference/admin/tuning-mem-usage/) page.
121
+
122
+
To set Pixie's data store memory limit when deploying with the [Pixie CLI](/installing-pixie/install-schemes/cli/), use the `--pem_flags` flag:
To set Pixie's data store memory limit when deploying with [Helm](/installing-pixie/install-schemes/helm/), use the `dataCollectorParams.customPEMFlags.PL_TABLE_STORE_DATA_LIMIT_MB` field:
When deploying Pixie, you have the option of setting the data access mode. This mode controls what data can be displayed when executing a [PxL script](/using-pixie) to query Pixie platform telemetry data. Pixie offers two data access modes:
137
+
138
+
-`Full` (default): The user has full data access, and Pixie does not redact any collected data from the user during script execution.
139
+
140
+
-`Restricted`: The user has restricted data access. Pixie will redact all columns that may potentially contain sensitive data (e.g. request/response bodies and headers). All rows in the column will be redacted, regardless of whether they do or do not actually contain PII. Metadata about these columns, such as length, will still be queryable.
141
+
142
+
If no data access mode is specified when deploying Pixie, the deploy assumes `Full` as default.
143
+
144
+
To set the data access mode when deploying with the [Pixie CLI](/installing-pixie/install-schemes/cli/), use the `--data_access` flag:
145
+
146
+
```bash
147
+
px deploy --data_access=(Full|Restricted)
148
+
```
149
+
150
+
To set the data access mode when deploying with [Helm](/installing-pixie/install-schemes/helm/), use the `dataAccess` field:
0 commit comments