Skip to content

Commit 9f2cf05

Browse files
committed
Address review several comments
1 parent b1a7e34 commit 9f2cf05

23 files changed

+1141
-733
lines changed

cmd/pyroscope/help-all.txt.tmpl

+140-8
Original file line numberDiff line numberDiff line change
@@ -625,14 +625,6 @@ Usage of ./pyroscope:
625625
Port to advertise to query-scheduler and querier (defaults to -server.http-listen-port).
626626
-query-frontend.scheduler-worker-concurrency int
627627
Number of concurrent workers forwarding queries to single query-scheduler. (default 5)
628-
-query-frontend.symbolizer.cache.enabled
629-
Enable debug info caching
630-
-query-frontend.symbolizer.cache.max-age duration
631-
Maximum age of cached debug info (default 168h0m0s)
632-
-query-frontend.symbolizer.debuginfod-url string
633-
URL of the debuginfod server (default "https://debuginfod.elfutils.org")
634-
-query-frontend.symbolizer.symbol-cache-size int
635-
Maximum number of entries in the symbol cache (default 100000)
636628
-query-scheduler.grpc-client-config.backoff-max-period duration
637629
Maximum delay when backing off. (default 10s)
638630
-query-scheduler.grpc-client-config.backoff-min-period duration
@@ -1083,6 +1075,146 @@ Usage of ./pyroscope:
10831075
True to enable zone-awareness and replicate blocks across different availability zones. This option needs be set both on the store-gateway and querier when running in microservices mode.
10841076
-store-gateway.tenant-shard-size int
10851077
The tenant's shard size, used when store-gateway sharding is enabled. Value of 0 disables shuffle sharding for the tenant, that is all tenant blocks are sharded across all store-gateway replicas.
1078+
-symbolizer.debuginfod-url string
1079+
URL of the debuginfod server (default "https://debuginfod.elfutils.org")
1080+
-symbolizer.enabled
1081+
Enable symbolization for unsymbolized profiles
1082+
-symbolizer.in-memory-debuginfo-cache-size int
1083+
Maximum size in bytes for the in-memory debug info cache (default 2147483648)
1084+
-symbolizer.in-memory-symbol-cache-size int
1085+
Maximum number of entries in the in-memory symbol cache (default 100000)
1086+
-symbolizer.persistent-debuginfo-store.enabled
1087+
Enable persistent debug info storage
1088+
-symbolizer.persistent-debuginfo-store.max-age duration
1089+
Maximum age of stored debug info (default 168h0m0s)
1090+
-symbolizer.persistent-debuginfo-store.storage.azure.account-key string
1091+
Azure storage account key. If unset, Azure managed identities will be used for authentication instead.
1092+
-symbolizer.persistent-debuginfo-store.storage.azure.account-name string
1093+
Azure storage account name
1094+
-symbolizer.persistent-debuginfo-store.storage.azure.connection-string string
1095+
If `connection-string` is set, the value of `endpoint-suffix` will not be used. Use this method over `account-key` if you need to authenticate via a SAS token. Or if you use the Azurite emulator.
1096+
-symbolizer.persistent-debuginfo-store.storage.azure.container-name string
1097+
Azure storage container name
1098+
-symbolizer.persistent-debuginfo-store.storage.azure.endpoint-suffix string
1099+
Azure storage endpoint suffix without schema. The account name will be prefixed to this value to create the FQDN. If set to empty string, default endpoint suffix is used.
1100+
-symbolizer.persistent-debuginfo-store.storage.azure.max-retries int
1101+
Number of retries for recoverable errors (default 3)
1102+
-symbolizer.persistent-debuginfo-store.storage.azure.user-assigned-id string
1103+
User assigned managed identity. If empty, then System assigned identity is used.
1104+
-symbolizer.persistent-debuginfo-store.storage.backend string
1105+
Backend storage to use. Supported backends are: s3, gcs, azure, swift, filesystem, cos.
1106+
-symbolizer.persistent-debuginfo-store.storage.cos.app-id string
1107+
COS app id
1108+
-symbolizer.persistent-debuginfo-store.storage.cos.bucket string
1109+
COS bucket name
1110+
-symbolizer.persistent-debuginfo-store.storage.cos.endpoint string
1111+
COS storage endpoint
1112+
-symbolizer.persistent-debuginfo-store.storage.cos.expect-continue-timeout duration
1113+
The time to wait for a server's first response headers after fully writing the request headers if the request has an Expect header. 0 to send the request body immediately. (default 1s)
1114+
-symbolizer.persistent-debuginfo-store.storage.cos.http.idle-conn-timeout duration
1115+
The time an idle connection will remain idle before closing. (default 1m30s)
1116+
-symbolizer.persistent-debuginfo-store.storage.cos.http.insecure-skip-verify
1117+
If the client connects to COS via HTTPS and this option is enabled, the client will accept any certificate and hostname.
1118+
-symbolizer.persistent-debuginfo-store.storage.cos.http.response-header-timeout duration
1119+
The amount of time the client will wait for a servers response headers. (default 2m0s)
1120+
-symbolizer.persistent-debuginfo-store.storage.cos.max-connections-per-host int
1121+
Maximum number of connections per host. 0 means no limit.
1122+
-symbolizer.persistent-debuginfo-store.storage.cos.max-idle-connections int
1123+
Maximum number of idle (keep-alive) connections across all hosts. 0 means no limit. (default 100)
1124+
-symbolizer.persistent-debuginfo-store.storage.cos.max-idle-connections-per-host int
1125+
Maximum number of idle (keep-alive) connections to keep per-host. If 0, a built-in default value is used. (default 100)
1126+
-symbolizer.persistent-debuginfo-store.storage.cos.region string
1127+
COS region name
1128+
-symbolizer.persistent-debuginfo-store.storage.cos.secret-id string
1129+
COS secret id
1130+
-symbolizer.persistent-debuginfo-store.storage.cos.secret-key string
1131+
COS secret key
1132+
-symbolizer.persistent-debuginfo-store.storage.cos.tls-handshake-timeout duration
1133+
Maximum time to wait for a TLS handshake. 0 means no limit. (default 10s)
1134+
-symbolizer.persistent-debuginfo-store.storage.filesystem.dir string
1135+
Local filesystem storage directory. (default "./data-shared")
1136+
-symbolizer.persistent-debuginfo-store.storage.gcs.bucket-name string
1137+
GCS bucket name
1138+
-symbolizer.persistent-debuginfo-store.storage.gcs.service-account string
1139+
JSON either from a Google Developers Console client_credentials.json file, or a Google Developers service account key. Needs to be valid JSON, not a filesystem path.
1140+
-symbolizer.persistent-debuginfo-store.storage.s3.access-key-id string
1141+
S3 access key ID
1142+
-symbolizer.persistent-debuginfo-store.storage.s3.bucket-lookup-type string
1143+
S3 bucket lookup style, use one of: [path-style virtual-hosted-style auto] (default "auto")
1144+
-symbolizer.persistent-debuginfo-store.storage.s3.bucket-name string
1145+
S3 bucket name
1146+
-symbolizer.persistent-debuginfo-store.storage.s3.endpoint string
1147+
The S3 bucket endpoint. It could be an AWS S3 endpoint listed at https://docs.aws.amazon.com/general/latest/gr/s3.html or the address of an S3-compatible service in hostname:port format.
1148+
-symbolizer.persistent-debuginfo-store.storage.s3.expect-continue-timeout duration
1149+
The time to wait for a server's first response headers after fully writing the request headers if the request has an Expect header. 0 to send the request body immediately. (default 1s)
1150+
-symbolizer.persistent-debuginfo-store.storage.s3.force-path-style
1151+
Deprecated, use s3.bucket-lookup-type instead. Set this to `true` to force the bucket lookup to be using path-style.
1152+
-symbolizer.persistent-debuginfo-store.storage.s3.http.idle-conn-timeout duration
1153+
The time an idle connection will remain idle before closing. (default 1m30s)
1154+
-symbolizer.persistent-debuginfo-store.storage.s3.http.insecure-skip-verify
1155+
If the client connects to S3 via HTTPS and this option is enabled, the client will accept any certificate and hostname.
1156+
-symbolizer.persistent-debuginfo-store.storage.s3.http.response-header-timeout duration
1157+
The amount of time the client will wait for a servers response headers. (default 2m0s)
1158+
-symbolizer.persistent-debuginfo-store.storage.s3.insecure
1159+
If enabled, use http:// for the S3 endpoint instead of https://. This could be useful in local dev/test environments while using an S3-compatible backend storage, like Minio.
1160+
-symbolizer.persistent-debuginfo-store.storage.s3.max-connections-per-host int
1161+
Maximum number of connections per host. 0 means no limit.
1162+
-symbolizer.persistent-debuginfo-store.storage.s3.max-idle-connections int
1163+
Maximum number of idle (keep-alive) connections across all hosts. 0 means no limit.
1164+
-symbolizer.persistent-debuginfo-store.storage.s3.max-idle-connections-per-host int
1165+
Maximum number of idle (keep-alive) connections to keep per-host. If 0, a built-in default value is used. (default 100)
1166+
-symbolizer.persistent-debuginfo-store.storage.s3.region string
1167+
S3 region. If unset, the client will issue a S3 GetBucketLocation API call to autodetect it.
1168+
-symbolizer.persistent-debuginfo-store.storage.s3.secret-access-key string
1169+
S3 secret access key
1170+
-symbolizer.persistent-debuginfo-store.storage.s3.signature-version string
1171+
The signature version to use for authenticating against S3. Supported values are: v4, v2. (default "v4")
1172+
-symbolizer.persistent-debuginfo-store.storage.s3.sse.kms-encryption-context string
1173+
KMS Encryption Context used for object encryption. It expects JSON formatted string.
1174+
-symbolizer.persistent-debuginfo-store.storage.s3.sse.kms-key-id string
1175+
KMS Key ID used to encrypt objects in S3
1176+
-symbolizer.persistent-debuginfo-store.storage.s3.sse.type string
1177+
Enable AWS Server Side Encryption. Supported values: SSE-KMS, SSE-S3.
1178+
-symbolizer.persistent-debuginfo-store.storage.s3.tls-handshake-timeout duration
1179+
Maximum time to wait for a TLS handshake. 0 means no limit. (default 10s)
1180+
-symbolizer.persistent-debuginfo-store.storage.storage-prefix string
1181+
[experimental] Prefix for all objects stored in the backend storage. For simplicity, it may only contain digits and English alphabet letters.
1182+
-symbolizer.persistent-debuginfo-store.storage.swift.auth-url string
1183+
OpenStack Swift authentication URL
1184+
-symbolizer.persistent-debuginfo-store.storage.swift.auth-version int
1185+
OpenStack Swift authentication API version. 0 to autodetect.
1186+
-symbolizer.persistent-debuginfo-store.storage.swift.connect-timeout duration
1187+
Time after which a connection attempt is aborted. (default 10s)
1188+
-symbolizer.persistent-debuginfo-store.storage.swift.container-name string
1189+
Name of the OpenStack Swift container to put chunks in.
1190+
-symbolizer.persistent-debuginfo-store.storage.swift.domain-id string
1191+
OpenStack Swift user's domain ID.
1192+
-symbolizer.persistent-debuginfo-store.storage.swift.domain-name string
1193+
OpenStack Swift user's domain name.
1194+
-symbolizer.persistent-debuginfo-store.storage.swift.max-retries int
1195+
Max retries on requests error. (default 3)
1196+
-symbolizer.persistent-debuginfo-store.storage.swift.password string
1197+
OpenStack Swift API key.
1198+
-symbolizer.persistent-debuginfo-store.storage.swift.project-domain-id string
1199+
ID of the OpenStack Swift project's domain (v3 auth only), only needed if it differs the from user domain.
1200+
-symbolizer.persistent-debuginfo-store.storage.swift.project-domain-name string
1201+
Name of the OpenStack Swift project's domain (v3 auth only), only needed if it differs from the user domain.
1202+
-symbolizer.persistent-debuginfo-store.storage.swift.project-id string
1203+
OpenStack Swift project ID (v2,v3 auth only).
1204+
-symbolizer.persistent-debuginfo-store.storage.swift.project-name string
1205+
OpenStack Swift project name (v2,v3 auth only).
1206+
-symbolizer.persistent-debuginfo-store.storage.swift.region-name string
1207+
OpenStack Swift Region to use (v2,v3 auth only).
1208+
-symbolizer.persistent-debuginfo-store.storage.swift.request-timeout duration
1209+
Time after which an idle request is aborted. The timeout watchdog is reset each time some data is received, so the timeout triggers after X time no data is received on a request. (default 5s)
1210+
-symbolizer.persistent-debuginfo-store.storage.swift.user-domain-id string
1211+
OpenStack Swift user's domain ID.
1212+
-symbolizer.persistent-debuginfo-store.storage.swift.user-domain-name string
1213+
OpenStack Swift user's domain name.
1214+
-symbolizer.persistent-debuginfo-store.storage.swift.user-id string
1215+
OpenStack Swift user ID.
1216+
-symbolizer.persistent-debuginfo-store.storage.swift.username string
1217+
OpenStack Swift username.
10861218
-target comma-separated-list-of-strings
10871219
Comma-separated list of Pyroscope modules to load. The alias 'all' can be used in the list to load a number of core modules and will enable single-binary mode. (default all)
10881220
-tenant-settings.collection-rules.alloy-template-path string

cmd/pyroscope/help.txt.tmpl

+88-8
Original file line numberDiff line numberDiff line change
@@ -173,14 +173,6 @@ Usage of ./pyroscope:
173173
Whether the series portion of query analysis is enabled. If disabled, no series data (e.g., series count) will be calculated by the /AnalyzeQuery endpoint.
174174
-querier.split-queries-by-interval duration
175175
Split queries by a time interval and execute in parallel. The value 0 disables splitting by time
176-
-query-frontend.symbolizer.cache.enabled
177-
Enable debug info caching
178-
-query-frontend.symbolizer.cache.max-age duration
179-
Maximum age of cached debug info (default 168h0m0s)
180-
-query-frontend.symbolizer.debuginfod-url string
181-
URL of the debuginfod server (default "https://debuginfod.elfutils.org")
182-
-query-frontend.symbolizer.symbol-cache-size int
183-
Maximum number of entries in the symbol cache (default 100000)
184176
-query-scheduler.max-outstanding-requests-per-tenant int
185177
Maximum number of outstanding requests per tenant per query-scheduler. In-flight requests above this limit will fail with HTTP response status code 429. (default 100)
186178
-query-scheduler.ring.consul.hostname string
@@ -409,6 +401,94 @@ Usage of ./pyroscope:
409401
True to enable zone-awareness and replicate blocks across different availability zones. This option needs be set both on the store-gateway and querier when running in microservices mode.
410402
-store-gateway.tenant-shard-size int
411403
The tenant's shard size, used when store-gateway sharding is enabled. Value of 0 disables shuffle sharding for the tenant, that is all tenant blocks are sharded across all store-gateway replicas.
404+
-symbolizer.debuginfod-url string
405+
URL of the debuginfod server (default "https://debuginfod.elfutils.org")
406+
-symbolizer.enabled
407+
Enable symbolization for unsymbolized profiles
408+
-symbolizer.in-memory-debuginfo-cache-size int
409+
Maximum size in bytes for the in-memory debug info cache (default 2147483648)
410+
-symbolizer.in-memory-symbol-cache-size int
411+
Maximum number of entries in the in-memory symbol cache (default 100000)
412+
-symbolizer.persistent-debuginfo-store.enabled
413+
Enable persistent debug info storage
414+
-symbolizer.persistent-debuginfo-store.max-age duration
415+
Maximum age of stored debug info (default 168h0m0s)
416+
-symbolizer.persistent-debuginfo-store.storage.azure.account-key string
417+
Azure storage account key. If unset, Azure managed identities will be used for authentication instead.
418+
-symbolizer.persistent-debuginfo-store.storage.azure.account-name string
419+
Azure storage account name
420+
-symbolizer.persistent-debuginfo-store.storage.azure.connection-string string
421+
If `connection-string` is set, the value of `endpoint-suffix` will not be used. Use this method over `account-key` if you need to authenticate via a SAS token. Or if you use the Azurite emulator.
422+
-symbolizer.persistent-debuginfo-store.storage.azure.container-name string
423+
Azure storage container name
424+
-symbolizer.persistent-debuginfo-store.storage.azure.endpoint-suffix string
425+
Azure storage endpoint suffix without schema. The account name will be prefixed to this value to create the FQDN. If set to empty string, default endpoint suffix is used.
426+
-symbolizer.persistent-debuginfo-store.storage.backend string
427+
Backend storage to use. Supported backends are: s3, gcs, azure, swift, filesystem, cos.
428+
-symbolizer.persistent-debuginfo-store.storage.cos.app-id string
429+
COS app id
430+
-symbolizer.persistent-debuginfo-store.storage.cos.bucket string
431+
COS bucket name
432+
-symbolizer.persistent-debuginfo-store.storage.cos.endpoint string
433+
COS storage endpoint
434+
-symbolizer.persistent-debuginfo-store.storage.cos.region string
435+
COS region name
436+
-symbolizer.persistent-debuginfo-store.storage.cos.secret-id string
437+
COS secret id
438+
-symbolizer.persistent-debuginfo-store.storage.cos.secret-key string
439+
COS secret key
440+
-symbolizer.persistent-debuginfo-store.storage.filesystem.dir string
441+
Local filesystem storage directory. (default "./data-shared")
442+
-symbolizer.persistent-debuginfo-store.storage.gcs.bucket-name string
443+
GCS bucket name
444+
-symbolizer.persistent-debuginfo-store.storage.gcs.service-account string
445+
JSON either from a Google Developers Console client_credentials.json file, or a Google Developers service account key. Needs to be valid JSON, not a filesystem path.
446+
-symbolizer.persistent-debuginfo-store.storage.s3.access-key-id string
447+
S3 access key ID
448+
-symbolizer.persistent-debuginfo-store.storage.s3.bucket-name string
449+
S3 bucket name
450+
-symbolizer.persistent-debuginfo-store.storage.s3.endpoint string
451+
The S3 bucket endpoint. It could be an AWS S3 endpoint listed at https://docs.aws.amazon.com/general/latest/gr/s3.html or the address of an S3-compatible service in hostname:port format.
452+
-symbolizer.persistent-debuginfo-store.storage.s3.region string
453+
S3 region. If unset, the client will issue a S3 GetBucketLocation API call to autodetect it.
454+
-symbolizer.persistent-debuginfo-store.storage.s3.secret-access-key string
455+
S3 secret access key
456+
-symbolizer.persistent-debuginfo-store.storage.s3.sse.kms-encryption-context string
457+
KMS Encryption Context used for object encryption. It expects JSON formatted string.
458+
-symbolizer.persistent-debuginfo-store.storage.s3.sse.kms-key-id string
459+
KMS Key ID used to encrypt objects in S3
460+
-symbolizer.persistent-debuginfo-store.storage.s3.sse.type string
461+
Enable AWS Server Side Encryption. Supported values: SSE-KMS, SSE-S3.
462+
-symbolizer.persistent-debuginfo-store.storage.swift.auth-url string
463+
OpenStack Swift authentication URL
464+
-symbolizer.persistent-debuginfo-store.storage.swift.auth-version int
465+
OpenStack Swift authentication API version. 0 to autodetect.
466+
-symbolizer.persistent-debuginfo-store.storage.swift.container-name string
467+
Name of the OpenStack Swift container to put chunks in.
468+
-symbolizer.persistent-debuginfo-store.storage.swift.domain-id string
469+
OpenStack Swift user's domain ID.
470+
-symbolizer.persistent-debuginfo-store.storage.swift.domain-name string
471+
OpenStack Swift user's domain name.
472+
-symbolizer.persistent-debuginfo-store.storage.swift.password string
473+
OpenStack Swift API key.
474+
-symbolizer.persistent-debuginfo-store.storage.swift.project-domain-id string
475+
ID of the OpenStack Swift project's domain (v3 auth only), only needed if it differs the from user domain.
476+
-symbolizer.persistent-debuginfo-store.storage.swift.project-domain-name string
477+
Name of the OpenStack Swift project's domain (v3 auth only), only needed if it differs from the user domain.
478+
-symbolizer.persistent-debuginfo-store.storage.swift.project-id string
479+
OpenStack Swift project ID (v2,v3 auth only).
480+
-symbolizer.persistent-debuginfo-store.storage.swift.project-name string
481+
OpenStack Swift project name (v2,v3 auth only).
482+
-symbolizer.persistent-debuginfo-store.storage.swift.region-name string
483+
OpenStack Swift Region to use (v2,v3 auth only).
484+
-symbolizer.persistent-debuginfo-store.storage.swift.user-domain-id string
485+
OpenStack Swift user's domain ID.
486+
-symbolizer.persistent-debuginfo-store.storage.swift.user-domain-name string
487+
OpenStack Swift user's domain name.
488+
-symbolizer.persistent-debuginfo-store.storage.swift.user-id string
489+
OpenStack Swift user ID.
490+
-symbolizer.persistent-debuginfo-store.storage.swift.username string
491+
OpenStack Swift username.
412492
-target comma-separated-list-of-strings
413493
Comma-separated list of Pyroscope modules to load. The alias 'all' can be used in the list to load a number of core modules and will enable single-binary mode. (default all)
414494
-tracing.enabled

0 commit comments

Comments
 (0)