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

docs(vrl): update documentation for parse_nginx_log with the main log format #22119

Merged

Conversation

virtualtam
Copy link
Contributor

@virtualtam virtualtam commented Jan 3, 2025

Summary

This PR updates the documentation for the parse_nginx_log VRL remap function with an example for parsing a log line formatted using the main format (see VRL issue and PR referenced below for more information).

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?

I have built the website documentation locally with:

$ cd rust-docs
$ make docs

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

Notes for reviewers

  • Looking at the VRL and Vector contributing guides, I am not sure whether this PR requires adding a changelog fragment; if so, please suggest the appropriate format for the changelog entry 📖

@virtualtam virtualtam requested review from a team as code owners January 3, 2025 17:25
@github-actions github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Jan 3, 2025
… log format

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
@pront pront enabled auto-merge January 7, 2025 20:58
@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Jan 10, 2025
@pront pront added this pull request to the merge queue Jan 10, 2025
Merged via the queue into vectordotdev:master with commit f8fde0f Jan 10, 2025
40 checks passed
@virtualtam virtualtam deleted the docs/parse_nginx_log/main-format branch January 12, 2025 13:58
@virtualtam
Copy link
Contributor Author

Thanks @pront for merging this PR and fixing the typos in the Cue files 👍

Though I followed the CONTRIBUTING / Running other checks, I didn't catch these issues locally, and the Github CI seems to require maintainer approvale before jobs are started.

Looking at one of the failed CI runs, these errors are caught in the Check Cue docs step by running make check-docs: https://github.com/vectordotdev/vector/actions/runs/12715110995/job/35446822563

Maybe this command could be added to the CONTRIBUTING guide in a section for documentation-related PRs, as well as any relevant command to check the documentation generation locally?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain: external docs Anything related to Vector's external, public documentation no-changelog Changes in this PR do not need user-facing explanations in the release changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants