Skip to content
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

chore(config): emit human-friendly version of enum variant/property names in schema #17171

Merged
merged 7 commits into from
Apr 19, 2023

Conversation

tobz
Copy link
Contributor

@tobz tobz commented Apr 18, 2023

Context

In many cases, the generated name for an enum variant in the configuration schema (logical_name) is suboptimal as it is not human-friendly: there's no spacing, or the casing is awkward because of rules around naming imposed by Rust itself. Additionally, but unrelatedly, the same principle applies to struct field names, and their resulting property names in the schema, as we're stuck with simply exposing the raw field name, where we want a more human-friendly description for it.

In #16467, the docs::label metadata attribute was added for providing a human-friendly name for the enum variants that contained all configurable components in Vector. Over time, as part of the work to extend component registration to once again be dynamic, this attribute has been lost due to needing to once again programmatically generate it in a derived way from the component type (e.g. aws_ec2_metadata) itself.

All in all, this represents a number of areas where the schema generation code, and the metadata annotations supporting schema generation, had various ways to provide a human-friendly name for enum variants and properties, but that fell short in different ways.

Solution

This PR introduces a few changes that, when combined, provide a consistent, human-friendly name for enum variants and properties across the board.

New shared code for generating human-friendly names

Some code was added to vector-config-common that centralizes the logic around parsing a given input string -- is it PascalCase? is it snake_case? -- and properly title casing it, and handling replacements (i.e. "PubSub" to "Pub/Sub") as well as properly capitalizing known acronyms, like AWS or GCP.

Switch dynamic component registration code to use new shared code

This is self-explanatory. The logic is now consolidated in one place.

New visitor for populating human-friendly names in schema metadata

A new visitor, GenerateHumanFriendlyNameVisitor, was added to fill in the gaps where we didn't already generate a human-friendly name, specifically for properties and most enum variants.

For enum variants, we already generated a metadata attribute called logical_name, which was the raw enum variant. We now process that and turn it into a human-friendly version. Similarly, for any object properties, we add a human-friendly version of the property name in the property's schema.

If a human-friendly name was manually provided in either of those cases, as in the metadata attribute already exists, the visitor skips that schema and continues: it does not overwrite. This gives us an escape hatch to manually adjust the human-friendly name when the source string (i.e. enum variant name or struct field name) cannot reasonably be changed without undue toil or backwards-incompatible changes.

Changed from docs::label to docs::human_name

It was a little opaque before, hopefully this new name provides a little more specificity.

@tobz tobz requested review from a team April 18, 2023 20:33
///
/// This visitor generates a human-friendly name for types and fields, stored in metadata
/// (`docs::human_name`) using a simple set of heuristics to figure out how to break apart
/// type/field names, as well as what the case of each word should be, including accomodations for

Check failure

Code scanning / check-spelling

Unrecognized Spelling

[accomodations](#security-tab) is not a recognized word. \(unrecognized-spelling\)
@netlify
Copy link

netlify bot commented Apr 18, 2023

Deploy Preview for vector-project canceled.

Name Link
🔨 Latest commit debdd07
🔍 Latest deploy log https://app.netlify.com/sites/vector-project/deploys/644009534e33f90008ccb7f1

@netlify
Copy link

netlify bot commented Apr 18, 2023

Deploy Preview for vrl-playground ready!

Name Link
🔨 Latest commit debdd07
🔍 Latest deploy log https://app.netlify.com/sites/vrl-playground/deploys/64400953fd93da0008f14cf3
😎 Deploy Preview https://deploy-preview-17171--vrl-playground.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions github-actions bot added the domain: sinks Anything related to the Vector's sinks label Apr 18, 2023
@datadog-vectordotdev
Copy link

datadog-vectordotdev bot commented Apr 18, 2023

Datadog Report

Branch report: tobz/config-schema-provide-default-docs-human-name
Commit report: 338960d

vector: 0 Failed, 0 New Flaky, 1873 Passed, 0 Skipped, 6m 42.24s Wall Time

@github-actions
Copy link

Regression Detector Results

Run ID: fbec0ae6-4c2d-402b-a873-4e1954e9b3cb
Baseline: 854d71e
Comparison: 500b22b
Total vector CPUs: 7

Explanation

A regression test is an integrated performance test for vector in a repeatable rig, with varying configuration for vector. What follows is a statistical summary of a brief vector run for each configuration across SHAs given above. The goal of these tests are to determine quickly if vector performance is changed and to what degree by a pull request.

The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values mean that baseline is faster, positive comparison. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed.

No interesting changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%.

Fine details of change detection per experiment.
experiment goal Δ mean Δ mean % confidence baseline mean baseline stdev baseline stderr baseline outlier % baseline CoV comparison mean comparison stdev comparison stderr comparison outlier % comparison CoV erratic declared erratic
syslog_humio_logs ingress throughput 225.66KiB/CPU-s 2.49 100.00% 8.86MiB/CPU-s 257.64KiB/CPU-s 3.32KiB/CPU-s 0.0 0.028393 9.08MiB/CPU-s 255.96KiB/CPU-s 3.3KiB/CPU-s 0.0 0.027523 False False
otlp_http_to_blackhole ingress throughput 33.43KiB/CPU-s 2.11 100.00% 1.54MiB/CPU-s 123.21KiB/CPU-s 1.59KiB/CPU-s 0.0 0.077897 1.58MiB/CPU-s 99.89KiB/CPU-s 1.29KiB/CPU-s 0.0 0.061848 False False
syslog_splunk_hec_logs ingress throughput 181.61KiB/CPU-s 2.03 100.00% 8.74MiB/CPU-s 273.82KiB/CPU-s 3.53KiB/CPU-s 0.0 0.030592 8.92MiB/CPU-s 204.03KiB/CPU-s 2.63KiB/CPU-s 0.0 0.022341 False False
datadog_agent_remap_datadog_logs_acks ingress throughput 577.83KiB/CPU-s 1.78 100.00% 31.74MiB/CPU-s 1.39MiB/CPU-s 18.4KiB/CPU-s 0.0 0.043859 32.3MiB/CPU-s 1.24MiB/CPU-s 16.38KiB/CPU-s 0.0 0.038366 False False
datadog_agent_remap_blackhole ingress throughput 474.07KiB/CPU-s 1.50 100.00% 30.88MiB/CPU-s 1.17MiB/CPU-s 15.39KiB/CPU-s 0.0 0.037725 31.35MiB/CPU-s 1.02MiB/CPU-s 13.41KiB/CPU-s 0.0 0.03238 False False
datadog_agent_remap_datadog_logs ingress throughput 452.56KiB/CPU-s 1.35 100.00% 32.75MiB/CPU-s 1.25MiB/CPU-s 16.54KiB/CPU-s 0.0 0.038215 33.19MiB/CPU-s 798.12KiB/CPU-s 10.3KiB/CPU-s 0.0 0.023483 False False
splunk_hec_route_s3 ingress throughput 147.86KiB/CPU-s 1.28 100.00% 11.3MiB/CPU-s 622.41KiB/CPU-s 8.03KiB/CPU-s 0.0 0.053804 11.44MiB/CPU-s 645.37KiB/CPU-s 8.33KiB/CPU-s 0.0 0.055085 False False
otlp_grpc_to_blackhole ingress throughput 12.59KiB/CPU-s 1.22 100.00% 1.01MiB/CPU-s 49.52KiB/CPU-s 654.46B/CPU-s 0.0 0.048055 1.02MiB/CPU-s 49.93KiB/CPU-s 659.8B/CPU-s 0.0 0.047866 False False
file_to_blackhole egress throughput 80.5KiB/CPU-s 1.11 31.22% 7.08MiB/CPU-s 3.96MiB/CPU-s 138.84KiB/CPU-s 0.0 0.55924 7.16MiB/CPU-s 4.1MiB/CPU-s 144.35KiB/CPU-s 0.0 0.572001 True True
syslog_log2metric_humio_metrics ingress throughput 53.23KiB/CPU-s 0.81 100.00% 6.44MiB/CPU-s 198.93KiB/CPU-s 2.57KiB/CPU-s 0.0 0.030161 6.49MiB/CPU-s 215.2KiB/CPU-s 2.78KiB/CPU-s 0.0 0.032366 False False
socket_to_socket_blackhole ingress throughput 73.21KiB/CPU-s 0.54 100.00% 13.13MiB/CPU-s 322.14KiB/CPU-s 4.16KiB/CPU-s 0.0 0.023951 13.21MiB/CPU-s 349.72KiB/CPU-s 4.51KiB/CPU-s 0.0 0.02586 False False
syslog_log2metric_splunk_hec_metrics ingress throughput 49.67KiB/CPU-s 0.53 100.00% 9.08MiB/CPU-s 237.03KiB/CPU-s 3.06KiB/CPU-s 0.0 0.025479 9.13MiB/CPU-s 353.4KiB/CPU-s 4.56KiB/CPU-s 0.0 0.037785 False False
syslog_loki ingress throughput 38.41KiB/CPU-s 0.45 100.00% 8.41MiB/CPU-s 211.89KiB/CPU-s 2.73KiB/CPU-s 0.0 0.024616 8.44MiB/CPU-s 236.27KiB/CPU-s 3.05KiB/CPU-s 0.0 0.027327 False False
datadog_agent_remap_blackhole_acks ingress throughput 12.72KiB/CPU-s 0.04 50.05% 30.34MiB/CPU-s 1.01MiB/CPU-s 13.39KiB/CPU-s 0.0 0.03339 30.35MiB/CPU-s 1.0MiB/CPU-s 13.25KiB/CPU-s 0.0 0.033027 False False
http_to_http_noack ingress throughput 4.18KiB/CPU-s 0.03 51.25% 13.61MiB/CPU-s 350.01KiB/CPU-s 4.52KiB/CPU-s 0.0 0.025113 13.61MiB/CPU-s 308.71KiB/CPU-s 3.98KiB/CPU-s 0.0 0.022142 False False
enterprise_http_to_http ingress throughput 4.02KiB/CPU-s 0.03 74.19% 13.62MiB/CPU-s 229.63KiB/CPU-s 2.96KiB/CPU-s 0.0 0.016463 13.62MiB/CPU-s 151.96KiB/CPU-s 1.96KiB/CPU-s 0.0 0.010891 False False
splunk_hec_to_splunk_hec_logs_acks ingress throughput -121.78B/CPU-s -0.00 1.39% 13.61MiB/CPU-s 376.97KiB/CPU-s 4.86KiB/CPU-s 0.0 0.027039 13.61MiB/CPU-s 369.24KiB/CPU-s 4.76KiB/CPU-s 0.0 0.026485 False False
splunk_hec_to_splunk_hec_logs_noack ingress throughput 318.0B/CPU-s 0.00 5.19% 13.62MiB/CPU-s 263.48KiB/CPU-s 3.4KiB/CPU-s 0.0 0.018896 13.62MiB/CPU-s 258.97KiB/CPU-s 3.34KiB/CPU-s 0.0 0.018572 False False
http_to_http_json ingress throughput -305.89B/CPU-s -0.00 5.74% 13.62MiB/CPU-s 226.08KiB/CPU-s 2.92KiB/CPU-s 0.0 0.016207 13.62MiB/CPU-s 228.43KiB/CPU-s 2.95KiB/CPU-s 0.0 0.016376 False False
fluent_elasticsearch ingress throughput 34.96B/CPU-s 0.00 5.01% 45.41MiB/CPU-s 30.19KiB/CPU-s 394.65B/CPU-s 0.0 0.000649 45.41MiB/CPU-s 29.95KiB/CPU-s 391.65B/CPU-s 0.0 0.000644 False False
splunk_hec_indexer_ack_blackhole ingress throughput -1.97KiB/CPU-s -0.01 32.53% 13.62MiB/CPU-s 250.92KiB/CPU-s 3.24KiB/CPU-s 0.0 0.017994 13.61MiB/CPU-s 262.21KiB/CPU-s 3.38KiB/CPU-s 0.0 0.018806 False False
http_text_to_http_json ingress throughput -91.83KiB/CPU-s -0.36 100.00% 24.69MiB/CPU-s 690.9KiB/CPU-s 8.92KiB/CPU-s 0.0 0.027324 24.6MiB/CPU-s 684.44KiB/CPU-s 8.83KiB/CPU-s 0.0 0.027167 False False
http_to_http_acks ingress throughput -31.48KiB/CPU-s -0.58 46.48% 5.28MiB/CPU-s 2.72MiB/CPU-s 35.92KiB/CPU-s 0.0 0.514924 5.25MiB/CPU-s 2.72MiB/CPU-s 35.88KiB/CPU-s 0.0 0.517522 True False
syslog_regex_logs2metric_ddmetrics ingress throughput -21.62KiB/CPU-s -0.60 99.86% 3.5MiB/CPU-s 380.71KiB/CPU-s 4.91KiB/CPU-s 0.0 0.10624 3.48MiB/CPU-s 357.97KiB/CPU-s 4.62KiB/CPU-s 0.0 0.100501 True True

Copy link
Contributor

@neuronull neuronull left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Member

@bruceg bruceg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks mostly okay, though I have a few questions about the lookup tables.

lib/vector-config-common/src/human_friendly.rs Outdated Show resolved Hide resolved
Comment on lines 8 to 15
/// Methods for splitting an input string into word segments.
pub enum SplitMethod {
/// Split inputs on case change boundaries.
Case,

/// Split inputs on underscore boundaries.
Underscore,
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we autodetect these? All identifiers that start with upper case would be split on case, and lowercase split on underscore.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had that thought that convert_case might do that, but hadn't explored it. I figured that depending on the usage, we'd always know the input format: enum variants are always PascalCase, and structs are always snake_case, and so specifying the split method manually at the individual callsites was good enough.

But it would be nice to make this simpler, so I can take a looksie.

lib/vector-config-common/src/human_friendly.rs Outdated Show resolved Hide resolved
@github-actions
Copy link

Regression Detector Results

Run ID: 5e037160-5cbb-48b3-a5e6-4a559d074edc
Baseline: 854d71e
Comparison: 8fe158e
Total vector CPUs: 7

Explanation

A regression test is an integrated performance test for vector in a repeatable rig, with varying configuration for vector. What follows is a statistical summary of a brief vector run for each configuration across SHAs given above. The goal of these tests are to determine quickly if vector performance is changed and to what degree by a pull request.

The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values mean that baseline is faster, positive comparison. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed.

No interesting changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%.

Fine details of change detection per experiment.
experiment goal Δ mean Δ mean % confidence baseline mean baseline stdev baseline stderr baseline outlier % baseline CoV comparison mean comparison stdev comparison stderr comparison outlier % comparison CoV erratic declared erratic
syslog_log2metric_splunk_hec_metrics ingress throughput 256.96KiB/CPU-s 2.78 100.00% 9.03MiB/CPU-s 360.13KiB/CPU-s 4.65KiB/CPU-s 0.0 0.03893 9.28MiB/CPU-s 294.21KiB/CPU-s 3.8KiB/CPU-s 0.0 0.030944 False False
datadog_agent_remap_blackhole ingress throughput 757.79KiB/CPU-s 2.42 100.00% 30.58MiB/CPU-s 1.67MiB/CPU-s 22.01KiB/CPU-s 0.0 0.054486 31.32MiB/CPU-s 1.06MiB/CPU-s 14.07KiB/CPU-s 0.0 0.033988 False False
socket_to_socket_blackhole ingress throughput 254.52KiB/CPU-s 1.87 100.00% 13.3MiB/CPU-s 374.74KiB/CPU-s 4.84KiB/CPU-s 0.0 0.027508 13.55MiB/CPU-s 216.01KiB/CPU-s 2.79KiB/CPU-s 0.0 0.015565 False False
otlp_http_to_blackhole ingress throughput 23.13KiB/CPU-s 1.46 100.00% 1.55MiB/CPU-s 111.86KiB/CPU-s 1.44KiB/CPU-s 0.0 0.070367 1.57MiB/CPU-s 90.87KiB/CPU-s 1.17KiB/CPU-s 0.0 0.056345 False False
datadog_agent_remap_datadog_logs_acks ingress throughput 416.04KiB/CPU-s 1.28 100.00% 31.77MiB/CPU-s 1.49MiB/CPU-s 19.72KiB/CPU-s 0.0 0.046967 32.18MiB/CPU-s 1.53MiB/CPU-s 20.28KiB/CPU-s 0.0 0.047702 False False
http_to_http_acks ingress throughput 57.6KiB/CPU-s 1.08 74.02% 5.21MiB/CPU-s 2.74MiB/CPU-s 36.16KiB/CPU-s 0.0 0.524982 5.27MiB/CPU-s 2.73MiB/CPU-s 36.12KiB/CPU-s 0.0 0.51892 True False
syslog_splunk_hec_logs ingress throughput 65.17KiB/CPU-s 0.72 100.00% 8.89MiB/CPU-s 224.24KiB/CPU-s 2.89KiB/CPU-s 0.0 0.024644 8.95MiB/CPU-s 245.87KiB/CPU-s 3.17KiB/CPU-s 0.0 0.026829 False False
syslog_loki ingress throughput 58.64KiB/CPU-s 0.69 100.00% 8.31MiB/CPU-s 268.88KiB/CPU-s 3.47KiB/CPU-s 0.0 0.031607 8.36MiB/CPU-s 263.13KiB/CPU-s 3.39KiB/CPU-s 0.0 0.030719 False False
syslog_regex_logs2metric_ddmetrics ingress throughput 3.5KiB/CPU-s 0.09 35.30% 3.71MiB/CPU-s 422.31KiB/CPU-s 5.45KiB/CPU-s 0.0 0.111267 3.71MiB/CPU-s 415.74KiB/CPU-s 5.37KiB/CPU-s 0.0 0.109435 True True
otlp_grpc_to_blackhole ingress throughput 724.75B/CPU-s 0.07 57.94% 1.01MiB/CPU-s 48.92KiB/CPU-s 646.4B/CPU-s 0.0 0.047123 1.01MiB/CPU-s 47.36KiB/CPU-s 625.9B/CPU-s 0.0 0.04559 False False
http_to_http_noack ingress throughput 8.12KiB/CPU-s 0.06 79.55% 13.61MiB/CPU-s 390.05KiB/CPU-s 5.03KiB/CPU-s 0.0 0.027993 13.61MiB/CPU-s 306.09KiB/CPU-s 3.95KiB/CPU-s 0.0 0.021955 False False
datadog_agent_remap_datadog_logs ingress throughput 10.96KiB/CPU-s 0.03 30.05% 32.36MiB/CPU-s 1.32MiB/CPU-s 17.39KiB/CPU-s 0.0 0.040652 32.37MiB/CPU-s 1.7MiB/CPU-s 22.46KiB/CPU-s 0.0 0.052472 False False
enterprise_http_to_http ingress throughput 4.22KiB/CPU-s 0.03 77.24% 13.62MiB/CPU-s 225.5KiB/CPU-s 2.91KiB/CPU-s 0.0 0.016167 13.62MiB/CPU-s 150.78KiB/CPU-s 1.95KiB/CPU-s 0.0 0.010807 False False
http_text_to_http_json ingress throughput 6.31KiB/CPU-s 0.03 36.07% 24.55MiB/CPU-s 858.99KiB/CPU-s 11.09KiB/CPU-s 0.0 0.034163 24.56MiB/CPU-s 592.11KiB/CPU-s 7.64KiB/CPU-s 0.0 0.023543 False False
splunk_hec_to_splunk_hec_logs_acks ingress throughput 264.38B/CPU-s 0.00 2.87% 13.61MiB/CPU-s 383.6KiB/CPU-s 4.95KiB/CPU-s 0.0 0.027515 13.61MiB/CPU-s 401.71KiB/CPU-s 5.18KiB/CPU-s 0.0 0.028814 False False
fluent_elasticsearch ingress throughput -1.31KiB/CPU-s -0.00 98.46% 45.41MiB/CPU-s 30.04KiB/CPU-s 392.78B/CPU-s 0.0 0.000646 45.41MiB/CPU-s 29.9KiB/CPU-s 390.76B/CPU-s 0.0 0.000643 False False
splunk_hec_indexer_ack_blackhole ingress throughput -121.83B/CPU-s -0.00 2.02% 13.62MiB/CPU-s 257.71KiB/CPU-s 3.32KiB/CPU-s 0.0 0.018482 13.62MiB/CPU-s 257.77KiB/CPU-s 3.33KiB/CPU-s 0.0 0.018487 False False
http_to_http_json ingress throughput -1.07KiB/CPU-s -0.01 20.31% 13.62MiB/CPU-s 227.39KiB/CPU-s 2.93KiB/CPU-s 0.0 0.016301 13.62MiB/CPU-s 228.57KiB/CPU-s 2.95KiB/CPU-s 0.0 0.016387 False False
splunk_hec_to_splunk_hec_logs_noack ingress throughput -4.69KiB/CPU-s -0.03 67.65% 13.62MiB/CPU-s 243.8KiB/CPU-s 3.15KiB/CPU-s 0.0 0.017481 13.61MiB/CPU-s 275.61KiB/CPU-s 3.56KiB/CPU-s 0.0 0.019769 False False
syslog_humio_logs ingress throughput -17.87KiB/CPU-s -0.20 99.97% 8.94MiB/CPU-s 172.02KiB/CPU-s 2.22KiB/CPU-s 0.0 0.018799 8.92MiB/CPU-s 345.33KiB/CPU-s 4.45KiB/CPU-s 0.0 0.037812 False False
datadog_agent_remap_blackhole_acks ingress throughput -231.94KiB/CPU-s -0.73 100.00% 31.18MiB/CPU-s 1.0MiB/CPU-s 13.27KiB/CPU-s 0.0 0.032192 30.96MiB/CPU-s 1.52MiB/CPU-s 20.06KiB/CPU-s 0.0 0.049012 False False
splunk_hec_route_s3 ingress throughput -128.25KiB/CPU-s -1.08 100.00% 11.59MiB/CPU-s 613.86KiB/CPU-s 7.92KiB/CPU-s 0.0 0.05174 11.46MiB/CPU-s 650.93KiB/CPU-s 8.4KiB/CPU-s 0.0 0.055464 False False
file_to_blackhole egress throughput -199.98KiB/CPU-s -2.59 68.48% 7.55MiB/CPU-s 3.9MiB/CPU-s 141.39KiB/CPU-s 0.0 0.51635 7.36MiB/CPU-s 3.93MiB/CPU-s 140.09KiB/CPU-s 0.0 0.534313 True True
syslog_log2metric_humio_metrics ingress throughput -205.93KiB/CPU-s -3.15 100.00% 6.37MiB/CPU-s 206.9KiB/CPU-s 2.67KiB/CPU-s 0.0 0.031693 6.17MiB/CPU-s 307.89KiB/CPU-s 3.97KiB/CPU-s 0.0 0.048699 False False

Copy link
Contributor

@spencergilbert spencergilbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside from clippy and the test fails, looks good to me - and much nicer than my fix 😂

Any thoughts on a rule of thumb for when to manually set this attribute vs adding new terms to the "exceptions" lists?

@tobz
Copy link
Contributor Author

tobz commented Apr 19, 2023

Aside from clippy and the test fails, looks good to me - and much nicer than my fix 😂

Any thoughts on a rule of thumb for when to manually set this attribute vs adding new terms to the "exceptions" lists?

The only practical reason to manually specify it is when the "input" string is not sufficient.

One example would be the aws_kinesis_firehose sink which currently overridden to be AWS Kinesis Data Firehose Logs. If removed and automatically generated, it would only yield AWS Kinesis Firehose, as the enum variant is AwsKinesisFirehose. In this case, we could change the enum variant to AwsKinesisDataFirehoseLogs if we wanted to, and then it would automatically generate in the same way.

For another example, however, where we couldn't simply tweak enum variant name, take the gcp_stackdriver_metrics sink. It is currently overridden to be GCP Cloud Monitoring (Stackdriver), which we couldn't automatically generate, even if we changed the enum variant... not without doing some specialized entry in the replacement map to get those parentheses.

Additionally, if we have a struct field name that we really want to tweak the human-friendly name for, then specifying the attribute manually is essentially the only way to achieve the intended outcome without introducing breaking changes or having to introduce aliases.. and in many cases, the non-human-friendly version of the desired human-friendly name would potentially just make no sense at all to use.

@spencergilbert
Copy link
Contributor

Cool, that's what I figured based on the changes you made - feels obvious enough to me from the existing usages.

@tobz tobz enabled auto-merge (squash) April 19, 2023 15:47
@github-actions
Copy link

Regression Detector Results

Run ID: 49f49bad-eecf-4f8a-8362-31c078494224
Baseline: 3c92556
Comparison: debdd07
Total vector CPUs: 7

Explanation

A regression test is an integrated performance test for vector in a repeatable rig, with varying configuration for vector. What follows is a statistical summary of a brief vector run for each configuration across SHAs given above. The goal of these tests are to determine quickly if vector performance is changed and to what degree by a pull request.

The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values mean that baseline is faster, positive comparison. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed.

Changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%:

experiment goal Δ mean Δ mean % confidence
syslog_log2metric_humio_metrics ingress throughput 374.46KiB/CPU-s 6.12 100.00%
Fine details of change detection per experiment.
experiment goal Δ mean Δ mean % confidence baseline mean baseline stdev baseline stderr baseline outlier % baseline CoV comparison mean comparison stdev comparison stderr comparison outlier % comparison CoV erratic declared erratic
syslog_log2metric_humio_metrics ingress throughput 374.46KiB/CPU-s 6.12 100.00% 5.97MiB/CPU-s 192.79KiB/CPU-s 2.49KiB/CPU-s 0.0 0.031524 6.34MiB/CPU-s 259.62KiB/CPU-s 3.35KiB/CPU-s 0.0 0.040002 False False
datadog_agent_remap_datadog_logs_acks ingress throughput 539.9KiB/CPU-s 1.65 100.00% 31.86MiB/CPU-s 1.24MiB/CPU-s 16.43KiB/CPU-s 0.0 0.039021 32.39MiB/CPU-s 1.09MiB/CPU-s 14.4KiB/CPU-s 0.0 0.033642 False False
datadog_agent_remap_blackhole_acks ingress throughput 250.59KiB/CPU-s 0.78 100.00% 31.25MiB/CPU-s 1.26MiB/CPU-s 16.71KiB/CPU-s 0.0 0.040456 31.49MiB/CPU-s 842.97KiB/CPU-s 10.88KiB/CPU-s 0.0 0.026139 False False
splunk_hec_route_s3 ingress throughput 90.38KiB/CPU-s 0.77 100.00% 11.51MiB/CPU-s 645.46KiB/CPU-s 8.33KiB/CPU-s 0.0 0.054774 11.6MiB/CPU-s 638.43KiB/CPU-s 8.24KiB/CPU-s 0.0 0.053766 False False
datadog_agent_remap_blackhole ingress throughput 154.74KiB/CPU-s 0.48 100.00% 31.25MiB/CPU-s 1.06MiB/CPU-s 14.02KiB/CPU-s 0.0 0.033953 31.4MiB/CPU-s 957.03KiB/CPU-s 12.35KiB/CPU-s 0.0 0.029764 False False
http_to_http_acks ingress throughput 16.13KiB/CPU-s 0.30 24.90% 5.2MiB/CPU-s 2.71MiB/CPU-s 35.86KiB/CPU-s 0.0 0.521756 5.22MiB/CPU-s 2.73MiB/CPU-s 36.03KiB/CPU-s 0.0 0.522619 True False
enterprise_http_to_http ingress throughput 8.34KiB/CPU-s 0.06 95.46% 13.62MiB/CPU-s 284.49KiB/CPU-s 3.67KiB/CPU-s 0.0 0.020402 13.62MiB/CPU-s 152.98KiB/CPU-s 1.98KiB/CPU-s 0.0 0.010965 False False
splunk_hec_indexer_ack_blackhole ingress throughput 952.47B/CPU-s 0.01 15.55% 13.61MiB/CPU-s 262.93KiB/CPU-s 3.39KiB/CPU-s 0.0 0.018858 13.62MiB/CPU-s 257.08KiB/CPU-s 3.32KiB/CPU-s 0.0 0.018437 False False
splunk_hec_to_splunk_hec_logs_acks ingress throughput -228.82B/CPU-s -0.00 2.70% 13.61MiB/CPU-s 354.99KiB/CPU-s 4.58KiB/CPU-s 0.0 0.025462 13.61MiB/CPU-s 368.82KiB/CPU-s 4.76KiB/CPU-s 0.0 0.026454 False False
http_to_http_json ingress throughput 13.5B/CPU-s 0.00 0.25% 13.62MiB/CPU-s 226.74KiB/CPU-s 2.93KiB/CPU-s 0.0 0.016255 13.62MiB/CPU-s 226.9KiB/CPU-s 2.93KiB/CPU-s 0.0 0.016266 False False
http_to_http_noack ingress throughput -7.48B/CPU-s -0.00 0.09% 13.61MiB/CPU-s 350.77KiB/CPU-s 4.53KiB/CPU-s 0.0 0.025167 13.61MiB/CPU-s 350.25KiB/CPU-s 4.52KiB/CPU-s 0.0 0.025129 False False
fluent_elasticsearch ingress throughput 280.5B/CPU-s 0.00 39.01% 45.41MiB/CPU-s 29.67KiB/CPU-s 388.04B/CPU-s 0.0 0.000638 45.41MiB/CPU-s 29.79KiB/CPU-s 389.37B/CPU-s 0.0 0.00064 False False
splunk_hec_to_splunk_hec_logs_noack ingress throughput -2.62KiB/CPU-s -0.02 40.67% 13.62MiB/CPU-s 259.14KiB/CPU-s 3.34KiB/CPU-s 0.0 0.018585 13.61MiB/CPU-s 277.9KiB/CPU-s 3.58KiB/CPU-s 0.0 0.019933 False False
otlp_grpc_to_blackhole ingress throughput -1.8KiB/CPU-s -0.17 95.91% 1.01MiB/CPU-s 52.95KiB/CPU-s 699.64B/CPU-s 0.0 0.050989 1.01MiB/CPU-s 43.13KiB/CPU-s 570.18B/CPU-s 0.0 0.041613 False False
http_text_to_http_json ingress throughput -120.47KiB/CPU-s -0.48 100.00% 24.73MiB/CPU-s 710.14KiB/CPU-s 9.17KiB/CPU-s 0.0 0.02804 24.61MiB/CPU-s 567.61KiB/CPU-s 7.33KiB/CPU-s 0.0 0.022519 False False
syslog_loki ingress throughput -45.12KiB/CPU-s -0.53 100.00% 8.31MiB/CPU-s 252.93KiB/CPU-s 3.26KiB/CPU-s 0.0 0.029719 8.27MiB/CPU-s 289.17KiB/CPU-s 3.73KiB/CPU-s 0.0 0.034158 False False
syslog_humio_logs ingress throughput -54.93KiB/CPU-s -0.59 100.00% 9.07MiB/CPU-s 198.93KiB/CPU-s 2.57KiB/CPU-s 0.0 0.021424 9.01MiB/CPU-s 300.08KiB/CPU-s 3.87KiB/CPU-s 0.0 0.032509 False False
otlp_http_to_blackhole ingress throughput -14.3KiB/CPU-s -0.88 100.00% 1.59MiB/CPU-s 94.97KiB/CPU-s 1.23KiB/CPU-s 0.0 0.058259 1.58MiB/CPU-s 93.59KiB/CPU-s 1.21KiB/CPU-s 0.0 0.057921 False False
socket_to_socket_blackhole ingress throughput -130.43KiB/CPU-s -0.95 100.00% 13.46MiB/CPU-s 316.55KiB/CPU-s 4.08KiB/CPU-s 0.0 0.022958 13.34MiB/CPU-s 278.73KiB/CPU-s 3.6KiB/CPU-s 0.0 0.020408 False False
syslog_regex_logs2metric_ddmetrics ingress throughput -39.4KiB/CPU-s -1.04 100.00% 3.7MiB/CPU-s 410.65KiB/CPU-s 5.3KiB/CPU-s 0.0 0.108434 3.66MiB/CPU-s 433.07KiB/CPU-s 5.59KiB/CPU-s 0.0 0.115556 True True
datadog_agent_remap_datadog_logs ingress throughput -407.58KiB/CPU-s -1.23 100.00% 32.44MiB/CPU-s 1013.47KiB/CPU-s 13.08KiB/CPU-s 0.0 0.030505 32.04MiB/CPU-s 1.52MiB/CPU-s 20.15KiB/CPU-s 0.0 0.047584 False False
syslog_log2metric_splunk_hec_metrics ingress throughput -128.34KiB/CPU-s -1.33 100.00% 9.4MiB/CPU-s 197.28KiB/CPU-s 2.55KiB/CPU-s 0.0 0.020493 9.27MiB/CPU-s 402.05KiB/CPU-s 5.19KiB/CPU-s 0.0 0.042329 False False
syslog_splunk_hec_logs ingress throughput -153.22KiB/CPU-s -1.65 100.00% 9.08MiB/CPU-s 192.5KiB/CPU-s 2.48KiB/CPU-s 0.0 0.020692 8.94MiB/CPU-s 224.07KiB/CPU-s 2.89KiB/CPU-s 0.0 0.024488 False False
file_to_blackhole egress throughput -192.28KiB/CPU-s -2.45 65.61% 7.65MiB/CPU-s 4.02MiB/CPU-s 146.8KiB/CPU-s 0.0 0.524665 7.46MiB/CPU-s 3.89MiB/CPU-s 140.34KiB/CPU-s 0.0 0.520397 True True

@tobz tobz merged commit 3b38ba8 into master Apr 19, 2023
@tobz tobz deleted the tobz/config-schema-provide-default-docs-human-name branch April 19, 2023 16:52
aholmberg pushed a commit to aholmberg/vector that referenced this pull request Feb 14, 2024
# [1.13.0](answerbook/vector@v1.12.1...v1.13.0) (2023-09-13)

### Bug Fixes

* **appsignal sink**: Add TLS config option (vectordotdev#17122) [198068c](answerbook/vector@198068c) - GitHub
* **buffers**: correctly handle partial writes in reader seek during initialization (vectordotdev#17099) [a791595](answerbook/vector@a791595) - GitHub
* **config**: recurse through schema refs when determining eligibility for unevaluated properties (vectordotdev#17150) [71d1bf6](answerbook/vector@71d1bf6) - GitHub
* **docker_logs source**: Support tcp schema [e1c0c02](answerbook/vector@e1c0c02) - GitHub
* **elasticsearch sink**:  Elasticsearch sink with api_version set to "auto" does not recognize the API version of ES6 as V6 (vectordotdev#17226) (vectordotdev#17227) [9b6ef24](answerbook/vector@9b6ef24) - GitHub
* **gcp_stackdriver_metrics sink**: Call function to regenerate auth token (vectordotdev#17297) [bf7904b](answerbook/vector@bf7904b) - GitHub
* **influxdb_logs**: encode influx line when no tags present (vectordotdev#17029) [c3aa14f](answerbook/vector@c3aa14f) - GitHub
* **reduce transform**: Revert flushing on interval change to `expire_metrics_ms` (vectordotdev#17084) [e86b155](answerbook/vector@e86b155) - GitHub
* **releasing**: Fix globbing of release artifacts for GitHub (vectordotdev#17114) [7fe089c](answerbook/vector@7fe089c) - GitHub
* **schemas**: Dont panic with non object field kinds (vectordotdev#17140) [1e43208](answerbook/vector@1e43208) - GitHub

### Chores

* (syslog source): add source_ip to some syslog tests (vectordotdev#17235) [29c34c0](answerbook/vector@29c34c0) - GitHub
* add note to DEVELOPING.md re panics (vectordotdev#17277) [03e905e](answerbook/vector@03e905e) - GitHub
* Add UX note about encoding of log_schema keys (vectordotdev#17266) [dc6e54c](answerbook/vector@dc6e54c) - GitHub
* **administration**: add `appsignal` to codeowners (vectordotdev#17127) [7b15d19](answerbook/vector@7b15d19) - GitHub
* **buffer**: tidy up some of the module level docs for `disk_v2` (vectordotdev#17093) [edaa612](answerbook/vector@edaa612) - GitHub
* **ci**: bump docker/metadata-action from 4.3.0 to 4.4.0 (vectordotdev#17170) [854d71e](answerbook/vector@854d71e) - GitHub
* **ci**: Disable `appsignal` integration test until CA issues are resolved (vectordotdev#17109) [f3b5d42](answerbook/vector@f3b5d42) - GitHub
* **ci**: Disable scheduled runs of Baseline Timings workflow (vectordotdev#17281) [4335b0a](answerbook/vector@4335b0a) - GitHub
* **ci**: Fix event assertions for `aws_ec2_metadata` transform (vectordotdev#17413) [da36fb6](answerbook/vector@da36fb6) - GitHub
* **ci**: Increase timeout for integration tests (vectordotdev#17326) [e1f125a](answerbook/vector@e1f125a) - GitHub
* **ci**: Increase timeout for integration tests to 30m (vectordotdev#17350) [5d3f619](answerbook/vector@5d3f619) - GitHub
* **ci**: re-enable `appsignal` integration test (vectordotdev#17111) [48fc574](answerbook/vector@48fc574) - GitHub
* **ci**: Remove ci-sweep tasks (vectordotdev#17415) [5c33f99](answerbook/vector@5c33f99) - GitHub
* **ci**: remove unnecessary dep install (vectordotdev#17128) [f56d1ef](answerbook/vector@f56d1ef) - GitHub
* **ci**: Try to fix apt retries (vectordotdev#17393) [6b3db04](answerbook/vector@6b3db04) - GitHub
* **ci**: update unsupported ubuntu version runners (vectordotdev#17113) [e7c4815](answerbook/vector@e7c4815) - GitHub
* **ci**: use python v3.8 in ubuntu 20.04 runner (vectordotdev#17116) [7a40c81](answerbook/vector@7a40c81) - GitHub
* **config**: begin laying out primitives for programmatically querying schema (vectordotdev#17130) [aad8115](answerbook/vector@aad8115) - GitHub
* **config**: emit human-friendly version of enum variant/property names in schema (vectordotdev#17171) [3b38ba8](answerbook/vector@3b38ba8) - GitHub
* **config**: improve config schema output with more precise `unevaluatedProperties` + schema ref flattening (vectordotdev#17026) [2d72f82](answerbook/vector@2d72f82) - GitHub
* **deps**: Add 3rd party license file and CI checks (vectordotdev#17344) [7350e1a](answerbook/vector@7350e1a) - GitHub
* **deps**: bump anyhow from 1.0.70 to 1.0.71 (vectordotdev#17300) [6a5af3b](answerbook/vector@6a5af3b) - GitHub
* **deps**: bump assert_cmd from 2.0.10 to 2.0.11 (vectordotdev#17290) [c4784fd](answerbook/vector@c4784fd) - GitHub
* **deps**: bump async-compression from 0.3.15 to 0.4.0 (vectordotdev#17365) [b9aac47](answerbook/vector@b9aac47) - GitHub
* **deps**: bump async-graphql from 5.0.7 to 5.0.8 (vectordotdev#17357) [05a4f17](answerbook/vector@05a4f17) - GitHub
* **deps**: bump async-graphql-warp from 5.0.7 to 5.0.8 (vectordotdev#17367) [693584e](answerbook/vector@693584e) - GitHub
* **deps**: bump async-stream from 0.3.4 to 0.3.5 (vectordotdev#17076) [c29c817](answerbook/vector@c29c817) - GitHub
* **deps**: bump aws-sigv4 from 0.55.0 to 0.55.1 (vectordotdev#17138) [dbb3f25](answerbook/vector@dbb3f25) - GitHub
* **deps**: bump axum from 0.6.12 to 0.6.18 (vectordotdev#17257) [41ac76e](answerbook/vector@41ac76e) - GitHub
* **deps**: bump cached from 0.42.0 to 0.43.0 (vectordotdev#17118) [f90b3b3](answerbook/vector@f90b3b3) - GitHub
* **deps**: bump chrono-tz from 0.8.1 to 0.8.2 (vectordotdev#17088) [623b838](answerbook/vector@623b838) - GitHub
* **deps**: bump clap_complete from 4.2.0 to 4.2.1 (vectordotdev#17229) [d286d16](answerbook/vector@d286d16) - GitHub
* **deps**: bump clap_complete from 4.2.1 to 4.2.2 (vectordotdev#17359) [565668e](answerbook/vector@565668e) - GitHub
* **deps**: bump clap_complete from 4.2.2 to 4.2.3 (vectordotdev#17383) [111cd07](answerbook/vector@111cd07) - GitHub
* **deps**: bump console-subscriber from 0.1.8 to 0.1.9 (vectordotdev#17358) [97b862c](answerbook/vector@97b862c) - GitHub
* **deps**: bump directories from 5.0.0 to 5.0.1 (vectordotdev#17271) [be69f5f](answerbook/vector@be69f5f) - GitHub
* **deps**: bump dunce from 1.0.3 to 1.0.4 (vectordotdev#17244) [cfc387d](answerbook/vector@cfc387d) - GitHub
* **deps**: bump enumflags2 from 0.7.5 to 0.7.6 (vectordotdev#17079) [cbc17be](answerbook/vector@cbc17be) - GitHub
* **deps**: bump enumflags2 from 0.7.6 to 0.7.7 (vectordotdev#17206) [c80c5eb](answerbook/vector@c80c5eb) - GitHub
* **deps**: bump flate2 from 1.0.25 to 1.0.26 (vectordotdev#17320) [ef13370](answerbook/vector@ef13370) - GitHub
* **deps**: bump getrandom from 0.2.8 to 0.2.9 (vectordotdev#17101) [d53240b](answerbook/vector@d53240b) - GitHub
* **deps**: bump h2 from 0.3.18 to 0.3.19 (vectordotdev#17388) [6088abd](answerbook/vector@6088abd) - GitHub
* **deps**: bump hashlink from 0.8.1 to 0.8.2 (vectordotdev#17419) [01b3cd7](answerbook/vector@01b3cd7) - GitHub
* **deps**: bump hyper from 0.14.25 to 0.14.26 (vectordotdev#17347) [c43dcfd](answerbook/vector@c43dcfd) - GitHub
* **deps**: bump inventory from 0.3.5 to 0.3.6 (vectordotdev#17401) [5b5ad16](answerbook/vector@5b5ad16) - GitHub
* **deps**: bump libc from 0.2.140 to 0.2.141 (vectordotdev#17104) [dd9608a](answerbook/vector@dd9608a) - GitHub
* **deps**: bump libc from 0.2.141 to 0.2.142 (vectordotdev#17273) [bc618a2](answerbook/vector@bc618a2) - GitHub
* **deps**: bump libc from 0.2.142 to 0.2.143 (vectordotdev#17338) [6afe206](answerbook/vector@6afe206) - GitHub
* **deps**: bump libc from 0.2.143 to 0.2.144 (vectordotdev#17346) [99b8dc1](answerbook/vector@99b8dc1) - GitHub
* **deps**: bump memmap2 from 0.5.10 to 0.6.0 (vectordotdev#17355) [dae0c6a](answerbook/vector@dae0c6a) - GitHub
* **deps**: bump memmap2 from 0.6.0 to 0.6.1 (vectordotdev#17364) [58ba741](answerbook/vector@58ba741) - GitHub
* **deps**: bump metrics, metrics-tracing-context, metrics-util (vectordotdev#17336) [9a723e3](answerbook/vector@9a723e3) - GitHub
* **deps**: bump mlua from 0.8.8 to 0.8.9 (vectordotdev#17423) [57f8bd4](answerbook/vector@57f8bd4) - GitHub
* **deps**: bump mock_instant from 0.2.1 to 0.3.0 (vectordotdev#17210) [40c9afc](answerbook/vector@40c9afc) - GitHub
* **deps**: bump mongodb from 2.4.0 to 2.5.0 (vectordotdev#17337) [64f4f69](answerbook/vector@64f4f69) - GitHub
* **deps**: bump nkeys from 0.2.0 to 0.3.0 (vectordotdev#17421) [3320eda](answerbook/vector@3320eda) - GitHub
* **deps**: bump notify from 5.1.0 to 6.0.0 (vectordotdev#17422) [58603b9](answerbook/vector@58603b9) - GitHub
* **deps**: bump num_enum from 0.5.11 to 0.6.0 (vectordotdev#17106) [42f298b](answerbook/vector@42f298b) - GitHub
* **deps**: bump num_enum from 0.6.0 to 0.6.1 (vectordotdev#17272) [f696e7b](answerbook/vector@f696e7b) - GitHub
* **deps**: bump opendal from 0.30.5 to 0.31.0 (vectordotdev#17119) [8762563](answerbook/vector@8762563) - GitHub
* **deps**: bump opendal from 0.31.0 to 0.33.2 (vectordotdev#17286) [3d41931](answerbook/vector@3d41931) - GitHub
* **deps**: bump opendal from 0.33.2 to 0.34.0 (vectordotdev#17354) [ae602da](answerbook/vector@ae602da) - GitHub
* **deps**: bump openssl from 0.10.48 to 0.10.50 (vectordotdev#17087) [9a56ed8](answerbook/vector@9a56ed8) - GitHub
* **deps**: bump openssl from 0.10.50 to 0.10.52 (vectordotdev#17299) [0ecceb3](answerbook/vector@0ecceb3) - GitHub
* **deps**: bump pin-project from 1.0.12 to 1.1.0 (vectordotdev#17385) [e8d3002](answerbook/vector@e8d3002) - GitHub
* **deps**: bump prettydiff from 0.6.2 to 0.6.4 (vectordotdev#17089) [e090610](answerbook/vector@e090610) - GitHub
* **deps**: bump prettydiff from 0.6.2 to 0.6.4 (vectordotdev#17315) [a1ec68d](answerbook/vector@a1ec68d) - GitHub
* **deps**: bump proc-macro2 from 1.0.55 to 1.0.56 (vectordotdev#17103) [6f74523](answerbook/vector@6f74523) - GitHub
* **deps**: bump proc-macro2 from 1.0.56 to 1.0.57 (vectordotdev#17400) [a6e1ae7](answerbook/vector@a6e1ae7) - GitHub
* **deps**: bump prost-build from 0.11.8 to 0.11.9 (vectordotdev#17260) [a88aba4](answerbook/vector@a88aba4) - GitHub
* **deps**: bump quote from 1.0.26 to 1.0.27 (vectordotdev#17348) [f81ff18](answerbook/vector@f81ff18) - GitHub
* **deps**: bump rdkafka from 0.29.0 to 0.30.0 (vectordotdev#17387) [9703188](answerbook/vector@9703188) - GitHub
* **deps**: bump regex from 1.7.3 to 1.8.1 (vectordotdev#17222) [410aa3c](answerbook/vector@410aa3c) - GitHub
* **deps**: bump reqwest from 0.11.16 to 0.11.17 (vectordotdev#17316) [09176ec](answerbook/vector@09176ec) - GitHub
* **deps**: bump security-framework from 2.8.2 to 2.9.0 (vectordotdev#17386) [1287168](answerbook/vector@1287168) - GitHub
* **deps**: bump serde from 1.0.159 to 1.0.160 (vectordotdev#17270) [036ad4a](answerbook/vector@036ad4a) - GitHub
* **deps**: bump serde from 1.0.160 to 1.0.162 (vectordotdev#17317) [79e97a2](answerbook/vector@79e97a2) - GitHub
* **deps**: bump serde from 1.0.162 to 1.0.163 (vectordotdev#17366) [9852c17](answerbook/vector@9852c17) - GitHub
* **deps**: bump serde_json from 1.0.95 to 1.0.96 (vectordotdev#17258) [7570bb3](answerbook/vector@7570bb3) - GitHub
* **deps**: bump serde_with from 2.3.1 to 2.3.2 (vectordotdev#17090) [adbf4d5](answerbook/vector@adbf4d5) - GitHub
* **deps**: bump serde_yaml from 0.9.19 to 0.9.21 (vectordotdev#17120) [d6f2625](answerbook/vector@d6f2625) - GitHub
* **deps**: bump socket2 from 0.4.7 to 0.5.2 (vectordotdev#17121) [db39d83](answerbook/vector@db39d83) - GitHub
* **deps**: bump socket2 from 0.5.2 to 0.5.3 (vectordotdev#17384) [ac51b8a](answerbook/vector@ac51b8a) - GitHub
* **deps**: bump syslog from 6.0.1 to 6.1.0 (vectordotdev#17301) [61e6154](answerbook/vector@61e6154) - GitHub
* **deps**: bump tokio from 1.27.0 to 1.28.0 (vectordotdev#17231) [8067f84](answerbook/vector@8067f84) - GitHub
* **deps**: bump tokio from 1.28.0 to 1.28.1 (vectordotdev#17368) [ae6a51b](answerbook/vector@ae6a51b) - GitHub
* **deps**: bump tokio-stream from 0.1.12 to 0.1.14 (vectordotdev#17339) [80c8247](answerbook/vector@80c8247) - GitHub
* **deps**: bump tokio-tungstenite from 0.18.0 to 0.19.0 (vectordotdev#17404) [ae1dd6e](answerbook/vector@ae1dd6e) - GitHub
* **deps**: bump tonic from 0.8.3 to 0.9.1 (vectordotdev#17077) [eafba69](answerbook/vector@eafba69) - GitHub
* **deps**: bump tonic from 0.9.1 to 0.9.2 (vectordotdev#17221) [aa9cbd0](answerbook/vector@aa9cbd0) - GitHub
* **deps**: bump tonic-build from 0.8.4 to 0.9.2 (vectordotdev#17274) [e0a07c6](answerbook/vector@e0a07c6) - GitHub
* **deps**: bump tracing-subscriber from 0.3.16 to 0.3.17 (vectordotdev#17268) [1406c08](answerbook/vector@1406c08) - GitHub
* **deps**: bump typetag from 0.2.7 to 0.2.8 (vectordotdev#17302) [c8e0e5f](answerbook/vector@c8e0e5f) - GitHub
* **deps**: bump uuid from 1.3.0 to 1.3.1 (vectordotdev#17091) [9cc2f1d](answerbook/vector@9cc2f1d) - GitHub
* **deps**: bump uuid from 1.3.0 to 1.3.2 (vectordotdev#17256) [bc6f7fd](answerbook/vector@bc6f7fd) - GitHub
* **deps**: bump uuid from 1.3.2 to 1.3.3 (vectordotdev#17403) [3a3fe63](answerbook/vector@3a3fe63) - GitHub
* **deps**: bump warp from 0.3.4 to 0.3.5 (vectordotdev#17288) [d8c1f12](answerbook/vector@d8c1f12) - GitHub
* **deps**: bump wasm-bindgen from 0.2.84 to 0.2.85 (vectordotdev#17356) [ea24b4d](answerbook/vector@ea24b4d) - GitHub
* **deps**: bump wasm-bindgen from 0.2.85 to 0.2.86 (vectordotdev#17402) [0518176](answerbook/vector@0518176) - GitHub
* **deps**: bump wiremock from 0.5.17 to 0.5.18 (vectordotdev#17092) [51312aa](answerbook/vector@51312aa) - GitHub
* **deps**: Fix up missing license (vectordotdev#17379) [a2b8903](answerbook/vector@a2b8903) - GitHub
* **deps**: Reset dependencies bumped by a61dea1 (vectordotdev#17100) [887d6d7](answerbook/vector@887d6d7) - GitHub
* **deps**: true up cargo.lock (vectordotdev#17149) [10fce65](answerbook/vector@10fce65) - GitHub
* **deps**: Update h2 (vectordotdev#17189) [a2882f3](answerbook/vector@a2882f3) - GitHub
* **deps**: Upgrade cue to 0.5.0 (vectordotdev#17204) [d396320](answerbook/vector@d396320) - GitHub
* **deps**: Upgrade Debian to bullseye for distroless image (vectordotdev#17160) [c304a8c](answerbook/vector@c304a8c) - GitHub
* **deps**: Upgrade rust to 1.69.0 (vectordotdev#17194) [ef15696](answerbook/vector@ef15696) - GitHub
* **dev**: Add note about generating licenses to CONTRIBUTING.md (vectordotdev#17410) [539f379](answerbook/vector@539f379) - GitHub
* **dev**: ignore `.helix` dir (vectordotdev#17203) [32a935b](answerbook/vector@32a935b) - GitHub
* **dev**: Install the correct `mold` based on CPU architecture (vectordotdev#17248) [4b80c71](answerbook/vector@4b80c71) - GitHub
* **dev**: remove editors from gitignore (vectordotdev#17267) [61c0d76](answerbook/vector@61c0d76) - GitHub
* **docs**: Add Enterprise link and update Support link (vectordotdev#17408) [5184d50](answerbook/vector@5184d50) - GitHub
* **docs**: Add missing 0.28.2 version [38607cd](answerbook/vector@38607cd) - Jesse Szwedko
* **docs**: Clarify `key_field` for `sample` and `throttle` transforms (vectordotdev#17372) [d1e5588](answerbook/vector@d1e5588) - GitHub
* **docs**: Document event type conditions (vectordotdev#17311) [a9c8dc8](answerbook/vector@a9c8dc8) - GitHub
* **docs**: make doc style edits (vectordotdev#17155) [65a8856](answerbook/vector@65a8856) - GitHub
* **docs**: Remove trailing, unmatched quote (vectordotdev#17163) [3c92556](answerbook/vector@3c92556) - GitHub
* **docs**: Remove unneeded `yaml` dependency from website (vectordotdev#17215) [752d424](answerbook/vector@752d424) - GitHub
* **docs**: Update component statuses 2023Q2 (vectordotdev#17362) [22cda94](answerbook/vector@22cda94) - GitHub
* **docs**: update the `v0.28.0` upgrade guide with note about `datadog_logs` sink `hostname` key (vectordotdev#17156) [c169131](answerbook/vector@c169131) - GitHub
* **external docs**: correctly mark some sinks as stateful (vectordotdev#17085) [64d560d](answerbook/vector@64d560d) - GitHub
* **loki sink**: warn on label expansions and collisions (vectordotdev#17052) [f06692b](answerbook/vector@f06692b) - GitHub
* **pulsar**: pulsar-rs bump to v5.1.1 (vectordotdev#17159) [68b54a9](answerbook/vector@68b54a9) - GitHub
* Re-add transform definitions (vectordotdev#17152) [9031d0f](answerbook/vector@9031d0f) - GitHub
* Regen docs for sample and throttle (vectordotdev#17390) [6c57ca0](answerbook/vector@6c57ca0) - GitHub
* **releasing**: Add known issues fixed by 0.29.1 (vectordotdev#17218) [40d543a](answerbook/vector@40d543a) - GitHub
* **releasing**: Bump Vector version to 0.30.0 (vectordotdev#17134) [3834612](answerbook/vector@3834612) - GitHub
* **releasing**: Fix homebrew release script (vectordotdev#17131) [cfbf233](answerbook/vector@cfbf233) - Jesse Szwedko
* **releasing**: Fix release channels (vectordotdev#17133) [58b44e8](answerbook/vector@58b44e8) - Jesse Szwedko
* **releasing**: Prepare v0.28.2 release [a61dea1](answerbook/vector@a61dea1) - Jesse Szwedko
* **releasing**: Prepare v0.29.0 release [4bf6805](answerbook/vector@4bf6805) - Jesse Szwedko
* **releasing**: Prepare v0.30.0 release [38c3f0b](answerbook/vector@38c3f0b) - Jesse Szwedko
* **releasing**: Regenerate Kubernetes manifests for 0.21.2 (vectordotdev#17108) [fd13d64](answerbook/vector@fd13d64) - GitHub
* **releasing**: Regenerate manifests for 0.21.1 chart (vectordotdev#17187) [1f0de6b](answerbook/vector@1f0de6b) - GitHub
* **releasing**: Regenerate manifests for 0.22.0 chart (vectordotdev#17135) [e7ea0a8](answerbook/vector@e7ea0a8) - GitHub
* **releasing**: update patch release template with extra step details [27c3526](answerbook/vector@27c3526) - GitHub
* Remove skaffold from project (vectordotdev#17145) [d245927](answerbook/vector@d245927) - GitHub
* remove transform type coercion (vectordotdev#17411) [b6c7e0a](answerbook/vector@b6c7e0a) - GitHub
* Revert transform definitions (vectordotdev#17146) [05a3f44](answerbook/vector@05a3f44) - GitHub
* **socket source**: Remove deprecated `max_length` setting from `tcp` and `unix` modes. (vectordotdev#17162) [9ecfc8c](answerbook/vector@9ecfc8c) - GitHub
* **syslog source**: remove the remove of source_ip (vectordotdev#17184) [5dff0ed](answerbook/vector@5dff0ed) - GitHub
* **topology**: Transform outputs hash table of OutputId -> Definition (vectordotdev#17059) [1bdb24d](answerbook/vector@1bdb24d) - GitHub
* Upgrade `VRL` to `0.3.0` (vectordotdev#17325) [4911d36](answerbook/vector@4911d36) - GitHub

### Features

* adds 'metric_name' field to internal logs for the tag_cardinality_limit component (vectordotdev#17295) [4317340](answerbook/vector@4317340) - GitHub
* **codecs**: Add full codec support to AWS S3 source/sink (vectordotdev#17098) [d648c86](answerbook/vector@d648c86) - GitHub
* **kubernetes_logs**: use kube-apiserver cache for list requests (vectordotdev#17095) [e46fae7](answerbook/vector@e46fae7) - GitHub
* Merge with upstream v0.30.0 [6b93177](answerbook/vector@6b93177) - GitHub [LOG-17997](https://logdna.atlassian.net/browse/LOG-17997)
* **new sink**: Initial `datadog_events` sink (vectordotdev#7678) [fef3810](answerbook/vector@fef3810) - Jesse Szwedko
* Update VRL library [6ace1e6](answerbook/vector@6ace1e6) - Jorge Bay

### Miscellaneous

* Merge branch 'master' [d4b35bb](answerbook/vector@d4b35bb) - Jorge Bay
* Merge tag 'v0.30.0' into update-upstream [ee2f300](answerbook/vector@ee2f300) - Jorge Bay
* Merge commit '9031d0faa2811187874364e1b5a3305c9ed0c0da' into update-upstream [c12faae](answerbook/vector@c12faae) - Jorge Bay
* Improve tokio::select behavior for kafka source and finalizers (vectordotdev#17380) [d4df21c](answerbook/vector@d4df21c) - GitHub
* Prepare v0.29.1 release [21beed7](answerbook/vector@21beed7) - Kyle Criddle
* Add a quickfix to handle special capitalization cases (vectordotdev#17141) [ba63e21](answerbook/vector@ba63e21) - GitHub
* Adjust doc comment locations (vectordotdev#17154) [730c938](answerbook/vector@730c938) - GitHub
* **amqp sink**: Support AMQ Properties (content-type) in AMQP sink (vectordotdev#17174) [c10d30b](answerbook/vector@c10d30b) - GitHub
* **aws provider**: Let `region` be configured for default authentication (vectordotdev#17414) [c81ad30](answerbook/vector@c81ad30) - GitHub
* **core**: add unit test (ignored) for support for encoding special chars in `ProxyConfig` (vectordotdev#17148) [5247972](answerbook/vector@5247972) - GitHub
* **loki sink**: Fix formatting in labels example (vectordotdev#17396) [f3734e8](answerbook/vector@f3734e8) - GitHub
* **observability**: Log underlying error for unhandled HTTP errors (vectordotdev#17327) [bf8376c](answerbook/vector@bf8376c) - GitHub
* **observability**: Update internal log rate limiting messages (vectordotdev#17394) [1951535](answerbook/vector@1951535) - GitHub
* **pulsar sink**: Refactor to use StreamSink (vectordotdev#14345) [1e97a2f](answerbook/vector@1e97a2f) - GitHub
* **topology**: Add source id to metadata (vectordotdev#17369) [c683999](answerbook/vector@c683999) - GitHub
* **vdev**: Load compose files and inject network block (vectordotdev#17025) [5d88655](answerbook/vector@5d88655) - GitHub
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain: sinks Anything related to the Vector's sinks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants