vector icon indicating copy to clipboard operation
vector copied to clipboard

Add OpenObserve as an officially supported sink

Open chaitanya-sistla opened this issue 1 year ago • 2 comments
trafficstars

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: https://github.com/vectordotdev/vector/issues/21514

chaitanya-sistla avatar Oct 17 '24 04:10 chaitanya-sistla

CLA assistant check
All committers have signed the CLA.

bits-bot avatar Oct 17 '24 04:10 bits-bot

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

chaitanya-sistla avatar Oct 17 '24 14:10 chaitanya-sistla

I have removed the space @pront

chaitanya-sistla avatar Oct 31 '24 19:10 chaitanya-sistla

Please add a changelog entry. You can find details on this document.

pront avatar Nov 06 '24 19:11 pront

added @pront

chaitanya-sistla avatar Nov 07 '24 02:11 chaitanya-sistla

Let's add a new "openobserve transform" scope somewhere here: https://github.com/vectordotdev/vector/blob/master/.github/workflows/semantic.yml#L182

pront avatar Nov 08 '24 17:11 pront

Also, please see https://github.com/vectordotdev/vector/blob/ac1e975d109e4ab575e2acb2f3766aa8084c8ea3/docs/DOCUMENTING.md?plain=1#L89

pront avatar Nov 08 '24 17:11 pront

@pront I don't have the file in my PR, do you want me to open a new PR or just add the file in my existing PR? https://github.com/vectordotdev/vector/blob/master/.github/workflows/semantic.yml#L182

chaitanya-sistla avatar Nov 13 '24 03:11 chaitanya-sistla

@pront I don't have the file in my PR, do you want me to open a new PR or just add the file in my existing PR? https://github.com/vectordotdev/vector/blob/master/.github/workflows/semantic.yml#L182

Feel free to ignore this, but you can sync your fork, git merge origin master and it should be there.

More importantly, the changelog format is off and is blocking this PR from merging.

pront avatar Nov 13 '24 15:11 pront