Skip to content

Commit c5618b2

Browse files
committed
Address feedback from Kyle
Signed-off-by: Stephen Wakely <fungus.humungus@gmail.com>
1 parent f2c5860 commit c5618b2

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

docs/REVIEWING.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,32 +37,34 @@ following items should also be checked:
3737
- [ ] Does it comply with the [instrumentation spec](specs/instrumentation.md)?
3838

3939

40-
### Sink review checklist
40+
### Checklist - new sink
4141

4242
This checklist is specific for Vector's sink code.
4343

44-
## Logic
44+
#### Logic
4545

4646
- [ ] Does it work? Do you understand what it is supposed to be doing?
4747
- [ ] Does the retry logic make sense?
4848
- [ ] Are the tests testing that the sink is emitting the correct metrics?
4949
- [ ] Are there integration tests?
5050

51-
## Code structure
51+
#### Code structure
5252

53-
- [ ] Is it using the sink prelude?
53+
- [ ] Is it using the sink prelude (`use crate::sinks::prelude::*`)?
54+
- [ ] Is the sink a stream based sink?
55+
Check that the return value from `SinkConfig::build` is the return from `VectorSink::from_event_streamsink`.
5456
- [ ] Is it gated by sensible feature flags?
5557
- [ ] Is the code modularized into `mod.rs`, `config.rs`, `sink.rs`, `request_builder.rs`, `service.rs`
5658
- [ ] Does the code follow our [style guidelines].
5759

58-
## Documentation
60+
#### Documentation
5961

60-
- [ ] Look at the doc preview on Netlify. Does it look good?
62+
- [ ] Look at the doc preview on Netlify. Does it look good?
6163
- [ ] Is there a `cue` file linking to `base`?
6264
- [ ] Is there a markdown file under `/website/content/en/docs/reference/configuration/sinks/`?
6365
- [ ] Are module comments included in `mod.rs` linking to any relevant areas in the external services documentation?
6466

65-
## Configuration
67+
#### Configuration
6668

6769
- [ ] Are TLS settings configurable?
6870
- [ ] Are the Request settings configurable?

0 commit comments

Comments
 (0)