Skip to content

bug: incorrect help message for several fields #586

@nitisht

Description

@nitisht

Currently when displaying help, there are several incorrect descriptions for flags / environment vars. Also several env vars are not documented on the docs page https://www.parseable.io/docs/env-vars.

This needs to be fixed.

➜  parseable git:(localcache) ./target/release/parseable local-store -h
Start Parseable with a drive as storage

Arguments:
  [filesystem path]  [env: P_FS_DIR=] [default: ./data]

Options:
      --tls-cert-path <PATH>
          The location of TLS Cert file [env: P_TLS_CERT_PATH=]
      --tls-key-path <PATH>
          The location of TLS Private Key file [env: P_TLS_KEY_PATH=]
      --address <ADDR:PORT>
          The address on which the http server will listen. [env: P_ADDR=] [default: 0.0.0.0:8000]
      --local-staging-path <DIR>
          The local staging path is used as a temporary landing point for incoming events and local cache [env: P_STAGING_DIR=] [default: ./staging]
      --cache-path <DIR>
          The local staging path is used as a temporary landing point for incoming events and local cache [env: P_CACHE_DIR=]
      --cache-size <mb>
          The local staging path is used as a temporary landing point for incoming events and local cache [env: P_CACHE_SIZE=] [default: 1000]
      --upload-interval <SECONDS>
          Interval in seconds after which un-committed data would be sent to the storage [env: P_STORAGE_UPLOAD_INTERVAL=] [default: 60]
      --username <STRING>
          Username for the basic authentication on the server [env: P_USERNAME=] [default: admin]
      --password <STRING>
          Password for the basic authentication on the server [env: P_PASSWORD=] [default: admin]
      --check-update <BOOL>
          Disable/Enable checking for updates [env: P_CHECK_UPDATE=] [default: true] [possible values: true, false]
      --send-analytics <BOOL>
          Disable/Enable sending anonymous user data [env: P_SEND_ANONYMOUS_USAGE_DATA=] [default: true] [possible values: true, false]
      --open-ai-key <STRING>
          Set OpenAI key to enable llm feature [env: P_OPENAI_API_KEY=]
      --oidc-client <STRING>
          Set client id for oidc provider [env: P_OIDC_CLIENT_ID=]
      --oidc-client-secret <STRING>
          Set client secret for oidc provider [env: P_OIDC_CLIENT_SECRET=]
      --oidc-issuer <URl>
          Set OIDC provider's host address. [env: P_OIDC_ISSUER=]
      --origin <URL>
          Set host global domain address [env: P_ORIGIN_URI=]
      --grpc-port <PORT>
          Set port for livetail arrow flight server [env: P_GRPC_PORT=] [default: 8001]
      --livetail-capacity <NUMBER>
          Set port for livetail arrow flight server [env: P_LIVETAIL_CAPACITY=] [default: 1000]
      --query-mempool-size <Gib>
          Set a fixed memory limit for query [env: P_QUERY_MEMORY_LIMIT=]
      --row-group-size <NUMBER>
          Number of rows in a row groups [env: P_PARQUET_ROW_GROUP_SIZE=] [default: 16384]
      --compression-algo <[UNCOMPRESSED, SNAPPY, GZIP, LZO, BROTLI, LZ4, ZSTD]>
          Parquet compression algorithm [env: P_PARQUET_COMPRESSION_ALGO=] [default: lz4] [possible values: uncompressed, snappy, gzip, lzo, brotli, lz4, zstd]
  -h, --help
          Print help
  -V, --version
          Print version

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions