Skip to content

README.md missing troubleshooting information #699

@pmcollins

Description

@pmcollins

Summary

The README.md has no troubleshooting section, which is required by the GDI specification.

Spec requirement

GDI Specification v1.8.0 — repository.md:

MUST have troubleshooting information in README.md

Current state

README.md contains only a brief description, getting started link, license info, and deprecation notice. There is no troubleshooting section.

Expected

Add a troubleshooting section covering common issues such as:

  • No data appearing in Splunk Observability Cloud
  • Service name not set warning
  • Verifying the collector is reachable
  • Enabling debug logging

Can link out to the official Splunk docs troubleshooting page if one exists.

References

  • README.md

Metadata

Metadata

Assignees

No one assigned

    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