Skip to content

Need comprehensive documentation for OBI config file fields #973

@itsCheithanya

Description

@itsCheithanya

Description:
Currently, there doesn't appear to be complete documentation listing all available fields that the OBI config file supports when running ./obi -config instrument-config.yml.

Request:
providing comprehensive documentation that includes:

  • A complete list of all supported config file fields
  • A template/example config file with all available options
  • Description of each field's purpose and accepted values
  • Default values for optional fields
  • Examples of common configuration scenarios

Use Case:
Users need a reference template to understand all configuration options available when instrumenting applications with OBI, rather than discovering fields through code inspection.

Additional Context:
This would help users:

  • Quickly set up proper instrumentation configurations
  • Understand all available customization options
  • Avoid configuration errors

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions