Add OpenObserve as an officially supported sink

[chaitanya-sistla]

This PR adds OpenObserve as an officially supported sink in Vector's documentation. OpenObserve utilizes an HTTP-based API for data ingestion, and this PR proposes updating the documentation with an example configuration for users to follow.

No new functionality is required, as the current HTTP sink already serves the purpose effectively. The primary goal is to improve user experience by offering clear guidance for setting up Vector with OpenObserve, ensuring confidence in its usage as a supported observability solution.

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

Why This Matters?
By officially documenting OpenObserve as a supported sink, we provide clear setup instructions for users, allowing them to confidently configure Vector for OpenObserve.

Closes: #21514

[bits-bot]

All committers have signed the CLA.

[chaitanya-sistla]

@jszwedko could you help me review this? Is anything pending from my end?

[pront]

Hello, this PR doesn't require any code changes and it seems more like a user guide on how to configure an existing sink. It feels like https://github.com/vectordotdev/vector-demos might be the right place for this. Or it could live under a new Community section in https://vector.dev/guides/

[pront]

I don't see this used anywhere else.

[chaitanya-sistla]

I was following #21514 (comment). Could you guide me on where to open a PR to be able to be added on https://vector.dev/guides/ ?

[pront]

Hi @chaitanya-sistla, thank you for pointing me to this. That proposal makes sense to me.

Since there is no precedent, let's think about it a bit:

• wrap an existing sink, hardcode configuration specific to OpenObserve and expose it as a new sink
• add a guide to the existing http docs, see example here
• add community guide on how to use it

Overall, I am happy with both options. But if we go with (1), we might need to do a few iterations since there is no precedent. Option (2) is more straightforward to do. For option (3), the guides live in website/content/en/guides.

Also, I would like to cc @jszwedko for awareness.

[chaitanya-sistla]

Thank you @pront I would like to follow the first approach if that is ideal. Does my PR reflect the Option (1)? Please let me know if I have to make any changes.

[jszwedko]

I think there is precedent for (1). An example would be the recent changes to the Axiom sink: #21362

[pront]

Regarding the CLA, can you try from a different browser or cleaning your cookies? Seems like the Github signin failed for you.

[chaitanya-sistla]

Thanks, I opened in other browsers, it doesn't show an option called Agree anywhere and auto redirects me to github once I signed in with my github.

[jszwedko]

Chaitanya Sistla seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.

I think the issue might be that your commits don't have an email address associated. Could you set an email address via git config user.email and the use git rebase to squash and then git commit --amend --reset-author to add an email address to the commits? The email you use should be associated with your GitHub account.

[jszwedko]

Hello @pront thank you. Yes I did and made the file changes, does this relate? I would love to make changes in addition but since we don't need any changes in type, I just modified the needed files.

The changes here only modify documentation. We need to actually implement another sink to follow existing precedent (i.e. write Rust code). See the axiom sink for an example: https://github.com/vectordotdev/vector/blob/master/src/sinks/axiom.rs. That sink also just wraps the http sink as you would do. Let me know if that is unclear!

[chaitanya-sistla]

Thank you, the cla issue is now resolved. Let me look into this.