A note for the community

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

Use Cases

Users are already successfully ingesting data from Vector into OpenObserve using the existing http sink. The goal of this request is to have OpenObserve officially documented as a supported sink in Vector, providing clear guidance for users on how to set it up. This will streamline the integration process for new users, reduce confusion, and ensure OpenObserve is recognized alongside other supported sinks in the documentation.

By including OpenObserve in the official documentation, we can provide a more straightforward path for users to ingest observability data like logs, metrics, and traces into OpenObserve.

Attempted Solutions

We have been using the http sink with the following configuration to ingest data into OpenObserve, which works without any issues:

[sinks.openobserve]
type = "http"
inputs = ["my_source"]
uri = "http://localhost:5080/api/default/default/_json"
method = "post"
auth.strategy = "basic"
auth.user = "[email protected]"
auth.password = "password"
compression = "gzip"
encoding.codec = "json"
encoding.timestamp_format = "rfc3339"
healthcheck.enabled = false

This setup works perfectly for current users. The ingestion process has been stable, and no breaking changes would be introduced with the official inclusion of OpenObserve in the Vector documentation. The main limitation we are facing is the lack of official recognition and ease of setup guidance for new users.

Proposal

We propose adding OpenObserve to the list of officially supported sinks in Vector's documentation. This would require updating the documentation with a simple example configuration, similar to the one above, and highlighting the use of OpenObserve’s HTTP-based API for data ingestion.

No new functionality is required, as the current http sink serves the purpose well. However, official recognition and clear setup instructions in the Vector documentation would significantly enhance the user experience and promote OpenObserve as an observability solution.

By doing this, users can confidently use Vector to send data to OpenObserve, knowing it’s a supported use case with clear guidance from both the Vector and OpenObserve teams.

References

No response

Version

No response