Skip to content

Commit 06bc733

Browse files
AbhishekvrshnyAbhishekvrshny
committed
docs: update docs with EnableProfilingHandlers param
1 parent 27b1397 commit 06bc733

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

‎docs/configurations.md‎

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,30 +8,31 @@ nav_order: 7
88

99
Configuration reference for `propeller.toml`.
1010

11-
| Config | Values | Description |
12-
|------------------------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------|
13-
| SendTestPayload | true/false | Periodically sends a test payload on the client channel. Useful for testing. |
14-
| SendTestPayloadToTopic | true/false | Periodically sends a test payload when a client subscribes to a custom topic. Useful for testing. |
15-
| ClientHeader | string | The metadata header key which is used to identify a client. |
16-
| EnableDeviceSupport | true/false | If enabled, a client can create a channel through multiple devices. Backend can send events targeting specific devices of a client. |
17-
| DeviceHeader | string | The metadata header key which is used to identify a device of a client. |
11+
| Config | Values | Description |
12+
|------------------------------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------|
13+
| SendTestPayload | true/false | Periodically sends a test payload on the client channel. Useful for testing. |
14+
| SendTestPayloadToTopic | true/false | Periodically sends a test payload when a client subscribes to a custom topic. Useful for testing. |
15+
| ClientHeader | string | The metadata header key which is used to identify a client. |
16+
| EnableDeviceSupport | true/false | If enabled, a client can create a channel through multiple devices. Backend can send events targeting specific devices of a client. |
17+
| DeviceHeader | string | The metadata header key which is used to identify a device of a client. |
1818
| DeviceAttributeHeaders | list of strings | (Optional) metadata header keys for attributes of a devices. They are listed when active devices for a client are fetched from the backend. |
19-
| broker.broker | redis/nats | The broker to be used. |
20-
| broker.persistence | true/false | If the broker should persist events in case the client is not connected and deliver them later when the client connects |
21-
| broker.nats | string | NATS address. |
22-
| broker.nats.EmbeddedServer | true/false | If enabled, an embedded NATS server is started. Useful for testing |
23-
| broker.redis | string | Redis address. |
24-
| broker.redis.Password | string | Redis password for authentication. |
25-
| broker.redis.TLSEnabled | true/false | If TLS should be enabled while connecting to Redis. |
26-
| broker.redis.ClusterModeEnabled | true/false | If cluster mode is enabled on Redis or not. Cluster mode helps with scalability by sharding keys. |
27-
| grpc.Address | string | gRPC server port to bind. |
28-
| grpc.PingIntervalInSec | integer | gRPC keepalive configuration. [Reference](https://grpc.io/docs/guides/keepalive/) |
29-
| grpc.PingResponseTimeoutInSec | integer | gRPC keepalive configuration. [Reference](https://grpc.io/docs/guides/keepalive/) |
30-
| Logger.type | dev/prod | prod logger prints logs in JSON while dev logger prints in human-friendly format. |
31-
| Http.Port | integer | HTTP port to bind for websockets and prometheus metrics endpoint. |
32-
| Features.\<name> | string | Feature flag for a new named feature. |
33-
| Features.\<name>.Enabled | true/false | If the feature should be enabled or not. |
34-
| Features.\<name>.RolloutPercentage | integer (0-100) | Percentage rollout of the feature. |
19+
| EnableProfilingHandlers | true/false | Enable `pprof` related `/debug` handlers for profiling |
20+
| broker.broker | redis/nats | The broker to be used. |
21+
| broker.persistence | true/false | If the broker should persist events in case the client is not connected and deliver them later when the client connects |
22+
| broker.nats | string | NATS address. |
23+
| broker.nats.EmbeddedServer | true/false | If enabled, an embedded NATS server is started. Useful for testing |
24+
| broker.redis | string | Redis address. |
25+
| broker.redis.Password | string | Redis password for authentication. |
26+
| broker.redis.TLSEnabled | true/false | If TLS should be enabled while connecting to Redis. |
27+
| broker.redis.ClusterModeEnabled | true/false | If cluster mode is enabled on Redis or not. Cluster mode helps with scalability by sharding keys. |
28+
| grpc.Address | string | gRPC server port to bind. |
29+
| grpc.PingIntervalInSec | integer | gRPC keepalive configuration. [Reference](https://grpc.io/docs/guides/keepalive/) |
30+
| grpc.PingResponseTimeoutInSec | integer | gRPC keepalive configuration. [Reference](https://grpc.io/docs/guides/keepalive/) |
31+
| Logger.type | dev/prod | prod logger prints logs in JSON while dev logger prints in human-friendly format. |
32+
| Http.Port | integer | HTTP port to bind for websockets and prometheus metrics endpoint. |
33+
| Features.\<name> | string | Feature flag for a new named feature. |
34+
| Features.\<name>.Enabled | true/false | If the feature should be enabled or not. |
35+
| Features.\<name>.RolloutPercentage | integer (0-100) | Percentage rollout of the feature. |
3536

3637
# Environment Variables Support
3738

0 commit comments

Comments
 (0)