-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add OpenObserve as an officially supported sink #21531
Open
chaitanya-sistla
wants to merge
4
commits into
vectordotdev:master
Choose a base branch
from
openobserve:feature/openobserve-sink
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -142,6 +142,7 @@ Nextbook | |
Nextcloud | ||
OVH | ||
Odys | ||
openobserve | ||
Openpeak | ||
Oppo | ||
Ovi | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
61 changes: 61 additions & 0 deletions
61
website/cue/reference/components/sinks/base/openobserve.cue
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
package metadata | ||
|
||
base: components: sinks: openobserve: configuration: { | ||
type: "http" | ||
inputs: ["source_or_transform_id"] | ||
uri: { | ||
description: "The OpenObserve endpoint to send data to." | ||
required: true | ||
type: string: examples: ["http://localhost:5080/api/default/default/_json"] | ||
} | ||
method: { | ||
description: "The HTTP method to use for the request." | ||
required: true | ||
type: string: default: "post" | ||
} | ||
auth: { | ||
description: "Authentication for OpenObserve." | ||
required: true | ||
type: object: options: { | ||
strategy: { | ||
description: "The authentication strategy." | ||
required: true | ||
type: string: default: "basic" | ||
} | ||
user: { | ||
description: "The username for basic authentication." | ||
required: true | ||
type: string: examples: ["[email protected]"] | ||
} | ||
password: { | ||
description: "The password for basic authentication." | ||
required: true | ||
type: string: examples: ["your_ingestion_password"] | ||
} | ||
} | ||
} | ||
compression: { | ||
description: "The compression algorithm to use." | ||
required: true | ||
type: string: default: "gzip" | ||
} | ||
encoding: { | ||
codec: { | ||
description: "The encoding format to use for the request body." | ||
required: true | ||
type: string: default: "json" | ||
} | ||
timestamp_format: { | ||
description: "The format for encoding timestamps." | ||
required: true | ||
type: string: default: "rfc3339" | ||
} | ||
} | ||
healthcheck: { | ||
enabled: { | ||
description: "Enables or disables the health check." | ||
required: true | ||
type: bool: default: false | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
package metadata | ||
|
||
components: sinks: openobserve: { | ||
title: "OpenObserve" | ||
|
||
features: { | ||
healthcheck: { | ||
enabled: false | ||
} | ||
send: { | ||
compression: { | ||
enabled: true | ||
default: "gzip" | ||
} | ||
encoding: { | ||
enabled: true | ||
codec: { | ||
enabled: true | ||
default: "json" | ||
} | ||
timestamp_format: { | ||
enabled: true | ||
default: "rfc3339" | ||
} | ||
} | ||
} | ||
} | ||
|
||
configuration: { | ||
type: "http" | ||
inputs: ["source_or_transform_id"] | ||
uri: { | ||
description: "The OpenObserve endpoint to send data to." | ||
required: true | ||
type: string: default: "http://localhost:5080/api/default/default/_json" | ||
} | ||
method: { | ||
description: "The HTTP method to use." | ||
required: true | ||
type: string: default: "post" | ||
} | ||
auth: { | ||
strategy: { | ||
description: "The authentication strategy." | ||
required: true | ||
type: string: default: "basic" | ||
} | ||
user: { | ||
description: "The username for basic authentication." | ||
required: true | ||
type: string: default: "[email protected]" | ||
} | ||
password: { | ||
description: "The password for basic authentication." | ||
required: true | ||
type: string: default: "your_ingestion_password" | ||
} | ||
} | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see this used anywhere else.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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/ ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there is precedent for (1). An example would be the recent changes to the Axiom sink: #21362
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regarding the CLA, can you try from a different browser or cleaning your cookies? Seems like the Github signin failed for you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 usegit rebase
to squash and thengit commit --amend --reset-author
to add an email address to the commits? The email you use should be associated with your GitHub account.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 thehttp
sink as you would do. Let me know if that is unclear!There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you, the cla issue is now resolved. Let me look into this.