docs(codecs): Document the output type of each decoder #24563
+434
−22
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.
Summary
This documents the output type (metric/logs/traces) generated by each decoder, based out the
output_typemethods in the decoder. Previously, this was only documented for the decoders that generated multiple types, but not for the ones that only generate logs or metrics.How did you test this PR?
Used
make generate-component-docto regenerate cue files (which I presume is the right thing to do for such a change, but it does not seem to be documented in CONTRIBUTING.md or other places I looked). Did not see how to generate actual HTML to see if the result looks ok.Change Type
Is this a breaking change?
Does this PR include user facing changes?
no-changeloglabel to this PR.