github.com/pyroscope-io/pyroscope@v0.37.3-0.20230725203016-5f6947968bd0/scripts/generate-sample-config/example.md (about)

     1  <!-- generate-sample-config:server:md -->
     2  | Name | Default Value | Usage |
     3  | :- | :- | :- |
     4  | analytics-opt-out | false | "disables analytics" |
     5  | log-level | info | "log level: debug|info|warn|error" |
     6  | badger-log-level | error | "log level: debug|info|warn|error" |
     7  | storage-path | /var/lib/pyroscope | "directory where pyroscope stores profiling data" |
     8  | api-bind-addr | :4040 | "port for the HTTP server used for data ingestion and web UI" |
     9  | base-url |  | "base URL for when the server is behind a reverse proxy with a different path" |
    10  | cache-dimension-size | 1000 | "max number of elements in LRU cache for dimensions" |
    11  | cache-dictionary-size | 1000 | "max number of elements in LRU cache for dictionaries" |
    12  | cache-segment-size | 1000 | "max number of elements in LRU cache for segments" |
    13  | cache-tree-size | 1000 | "max number of elements in LRU cache for trees" |
    14  | badger-no-truncate | false | "indicates whether value log files should be truncated to delete corrupt data, if any" |
    15  | max-nodes-serialization | 2048 | "max number of nodes used when saving profiles to disk" |
    16  | max-nodes-render | 8192 | "max number of nodes used to display data on the frontend" |
    17  | hide-applications |  | "please don't use, this will soon be deprecated" |
    18  | out-of-space-threshold | 512.00 MB | "Threshold value to consider out of space in bytes" |
    19  | sample-rate | 100 | "sample rate for the profiler in Hz. 100 means reading 100 times per second" |
    20  <!-- /generate-sample-config -->
    21  
    22  <!-- generate-sample-config:server:yaml -->
    23  ```yaml
    24  ---
    25  # disables analytics
    26  analytics-opt-out: "false"
    27  
    28  # log level: debug|info|warn|error
    29  log-level: "info"
    30  
    31  # log level: debug|info|warn|error
    32  badger-log-level: "error"
    33  
    34  # directory where pyroscope stores profiling data
    35  storage-path: "/var/lib/pyroscope"
    36  
    37  # port for the HTTP server used for data ingestion and web UI
    38  api-bind-addr: ":4040"
    39  
    40  # base URL for when the server is behind a reverse proxy with a different path
    41  base-url: ""
    42  
    43  # max number of elements in LRU cache for dimensions
    44  cache-dimension-size: "1000"
    45  
    46  # max number of elements in LRU cache for dictionaries
    47  cache-dictionary-size: "1000"
    48  
    49  # max number of elements in LRU cache for segments
    50  cache-segment-size: "1000"
    51  
    52  # max number of elements in LRU cache for trees
    53  cache-tree-size: "1000"
    54  
    55  # indicates whether value log files should be truncated to delete corrupt data, if any
    56  badger-no-truncate: "false"
    57  
    58  # max number of nodes used when saving profiles to disk
    59  max-nodes-serialization: "2048"
    60  
    61  # max number of nodes used to display data on the frontend
    62  max-nodes-render: "8192"
    63  
    64  # please don't use, this will soon be deprecated
    65  hide-applications: ""
    66  
    67  # Threshold value to consider out of space in bytes
    68  out-of-space-threshold: "512.00 MB"
    69  
    70  # sample rate for the profiler in Hz. 100 means reading 100 times per second
    71  sample-rate: "100"
    72  
    73  ```
    74  <!-- /generate-sample-config -->