Skip to content

Commit c8bd9cc

Browse files
authored
update PEM flag documentation to enable/disable protocols (#274)
Signed-off-by: Benjamin Kilimnik <bkilimnik@pixielabs.ai>
1 parent 8b383f9 commit c8bd9cc

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

content/en/05-reference/01-admin/03-deploy-options.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -298,14 +298,15 @@ kubectl apply -f yamls/vizier_deps/etcd_prod.yaml
298298

299299
PEM flags are used to configure the [Pixie Edge Module](/reference/architecture/#vizier-components), Pixie's data collector component. PEM flags are often used to enable beta features.
300300

301-
For example, to enable `STIRLING_ENABLE_AMQP_TRACING` when deploying with the [Pixie CLI](/installing-pixie/install-schemes/cli/), use the `--pem_flags` flag:
301+
For example, to disable tracing for specific protocols (e.g. to reduce memory usage) when deploying with the [Pixie CLI](/installing-pixie/install-schemes/cli/), use the `--pem_flags` flag.
302302

303303
```bash
304-
px deploy --pem_flags="STIRLING_ENABLE_AMQP_TRACING=true"
304+
px deploy --pem_flags="PX_STIRLING_ENABLE_AMQP_TRACING=0"
305305
```
306+
Flags follow the pattern `PX_STIRLING_ENABLE_[PROTOCOL]_TRACING`. Available protocols are listed on the [data sources page](https://docs.px.dev/about-pixie/data-sources/#supported-protocols) and tracing may be disabled by passing `0` or enabled with `1`.
306307

307-
To enable `STIRLING_ENABLE_AMQP_TRACING` when deploying with [Helm](/installing-pixie/install-schemes/helm/), use the `dataCollectorParams.customPEMFlags` field:
308+
To disable a protocol when deploying with [Helm](/installing-pixie/install-schemes/helm/), use the `dataCollectorParams.customPEMFlags` field:
308309

309310
```bash
310-
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --namespace pl --create-namespace --set dataCollectorParams.customPEMFlags.STIRLING_ENABLE_AMQP_TRACING=true
311+
helm install pixie pixie-operator/pixie-operator-chart --set deployKey=<deploy-key-goes-here> --namespace pl --create-namespace --set dataCollectorParams.customPEMFlags.PX_STIRLING_ENABLE_AMQP_TRACING=0
311312
```

0 commit comments

Comments
 (0)