feat(new sink): Keep sink

[sainad2222]

Change Type

• Bug fix
• New feature
• Non-functional (chore, refactoring, docs)
• Performance

Is this a breaking change?

• Yes
• No

How did you test this PR?

Vector config:

sources:
  prometheus:
    type: http
    address: 0.0.0.0:8686

sinks:
  keep:
    type: "keep"
    inputs: ["prometheus"]
    endpoint: "http://localhost:8080/alerts/event/vectordev?provider_id=test"
    api_key: "keepappkey"

Does this PR include user facing changes?

• Yes. Please add a changelog fragment based on our guidelines.
• No. A maintainer will apply the "no-changelog" label to this PR.

Checklist

• Please read our Vector contributor resources.
• If this PR introduces changes Vector dependencies (modifies Cargo.lock), please
  run dd-rust-license-tool write to regenerate the license inventory and commit the changes (if any). More details here.

References

• Closes: Add Keep sink #21965

[bits-bot]

All committers have signed the CLA.

[talboren]

@sainad2222 looks good!!

[pront]

Thanks @sainad2222, can you add a changelong fragment?

[pront]

Also, please take a look at this PR as an example on how to include this new sink to our website: https://github.com/vectordotdev/vector/pull/13007/files#diff-a0be14524a6e437c68388b393dbff417eceb1dd09857df9173b3e6f217f57376

You can start with the following:

• Run make generate-component-docs
• Add a website/content/en/docs/reference/configuration/sinks/keep.md

[rtrieu]

Hi, I left some feedback for your review, mostly to maintain style consistency.

[sainad2222]

@rtrieu @pront Moved the documentation fixes to a separate PR
#22200

[pront]

Hi @sainad2222, thanks for your patience on this PR. I understand we lack some guidance here on adding docs for new components. We are still missing CUE files.

See other sinks for inspiration or a recent PR here.

Note we have two folders:

• website/cue/reference/components/sinks/base/keep.cue (like the one you generated here)
• website/cue/reference/components/sinks

This is useful because it adds doc tags to the sink like "beta" etc.

[talboren]

Hi @sainad2222, thanks for your patience on this PR. I understand we lack some guidance here on adding docs for new components. We are still missing CUE files.

See other sinks for inspiration or a recent PR here.

Note we have two folders:

• website/cue/reference/components/sinks/base/keep.cue (like the one you generated here)
• website/cue/reference/components/sinks

This is useful because it adds doc tags to the sink like "beta" etc.

excited to see this PR getting merged 🤩

[sainad2222]

Hi @pront, my aplogies for missing this earlier. I will add the other cue files too. Btw do you mean the two folders being website/cue/reference/components/sinks/base/keep.cue and website/cue/reference/services/keep.cue(this is missing)?
I'll also try to build the website locally to see if it as expected
Thanks

[sainad2222]

@pront How do we generate website/cue/reference/components/sinks/keep.cue? I checked Makefile but could only find generate-component-docs. If it's the same command then I don't see any errors too. It's only generating base/keep.cue

website/cue/reference/services/keep.cue (which I wonder if it should have been generated for you)

It also didn't get auto generated for me

[pront]

@pront How do we generate website/cue/reference/components/sinks/keep.cue? I checked Makefile but could only find generate-component-docs. If it's the same command then I don't see any errors too. It's only generating base/keep.cue

website/cue/reference/services/keep.cue (which I wonder if it should have been generated for you)

It also didn't get auto generated for me

That needs to be added manually.

[sainad2222]

I added the file and looks to be fine in website too. I modified the fields based on my understanding and reading about the others. Feel free to modify if something is wrong in the new cue file website/cue/reference/components/sinks/keep.cue. You can review rest of the files too in the meantime

review comments were addressed

[rtrieu]

Suggested change

	2. Go to providers tab and setup vector as a provider
	2. Go to the providers tab and setup vector as a provider

[talboren]

@rtrieu @pront quick question: we should we be able to see Keep's sink in the website/docs?

[sainad2222]

@talboren I think it will be available once next release goes out

[pront]

@talboren I think it will be available once next release goes out

@sainad2222 is right, the website branch doesn't contain this commit yet.

[sainad2222]

@talboren Feel free to build website locally for now and make suggestions on documentation. I feel like we should make a "How it works" with examples since we expect specific id in the configuration(prometheus although thinking to rename it to prometheus_alertmanager, so will need to change accordingly at Keep too)

[talboren]

@talboren Feel free to build website locally for now and make suggestions on documentation. I feel like we should make a "How it works" with examples since we expect specific id in the configuration(prometheus although thinking to rename it to prometheus_alertmanager, so will need to change accordingly at Keep too)

Let me know if you want to collaborate on it!

[sainad2222]

@talboren Feel free to build website locally for now and make suggestions on documentation. I feel like we should make a "How it works" with examples since we expect specific id in the configuration(prometheus although thinking to rename it to prometheus_alertmanager, so will need to change accordingly at Keep too)

Let me know if you want to collaborate on it!

Yes, I can take up the changes needed