Skip to content

docs(external): add docs for haversine VRL function #23336

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 12 commits into from
Jul 21, 2025
Merged

docs(external): add docs for haversine VRL function #23336

merged 12 commits into from
Jul 21, 2025

Conversation

esensar
Copy link
Contributor

@esensar esensar commented Jul 3, 2025

Summary

Adds docs for the new haversine VRL function.

Change Type

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

Is this a breaking change?

  • Yes
  • No

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.

References

Notes

  • Please read our Vector contributor resources.
  • Do not hesitate to use @vectordotdev/vector to reach out to us regarding this PR.
  • Some CI checks run only after we manually approve them.
    • We recommend adding a pre-push hook, please see this template.
    • Alternatively, we recommend running the following locally before pushing to the remote branch:
      • cargo fmt --all
      • cargo clippy --workspace --all-targets -- -D warnings
      • cargo nextest run --workspace (alternatively, you can run cargo test --all)
  • After a review is requested, please avoid force pushes to help us review incrementally.
    • Feel free to push as many commits as you want. They will be squashed into one before merging.
    • For example, you can run git merge origin master and git push.
  • If this PR introduces changes Vector dependencies (modifies Cargo.lock), please
    run cargo vdev build licenses to regenerate the license inventory and commit the changes (if any). More details here.

Sponsored by Quad9

@esensar esensar requested a review from a team as a code owner July 3, 2025 16:18
@github-actions github-actions bot added the domain: external docs Anything related to Vector's external, public documentation label Jul 3, 2025
@esensar esensar mentioned this pull request Jul 3, 2025
Merged
11 tasks
rtrieu
rtrieu requested changes Jul 3, 2025
View reviewed changes
Copy link
Contributor

@rtrieu rtrieu left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution! I left you some feedback and suggestions for your review, mainly for clarity and consistency. Please re-request a review when ready.

@esensar esensar requested a review from rtrieu July 4, 2025 09:17
esensar
esensar commented Jul 4, 2025
View reviewed changes
pront
pront approved these changes Jul 9, 2025
View reviewed changes
Copy link
Member

@pront pront left a comment

Choose a reason for hiding this comment

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

You can also do a cargo update -p vrl now after the VRL PR is merged.

@esensar esensar requested a review from a team as a code owner July 9, 2025 16:12
@pront pront added the no-changelog Changes in this PR do not need user-facing explanations in the release changelog label Jul 9, 2025
@pront pront enabled auto-merge July 9, 2025 17:13
@pront pront force-pushed the master branch 4 times, most recently from 1720078 to ffe54be Compare July 10, 2025 15:43
@esensar esensar mentioned this pull request Jul 11, 2025
Merged
11 tasks
@pront pront disabled auto-merge July 11, 2025 19:44
@pront pront added the meta: awaiting author Pull requests that are awaiting their author. label Jul 11, 2025
@pront pront self-assigned this Jul 11, 2025
@github-actions github-actions bot removed the meta: awaiting author Pull requests that are awaiting their author. label Jul 15, 2025
@pront pront enabled auto-merge July 15, 2025 13:59
auto-merge was automatically disabled July 15, 2025 15:00

Head branch was pushed to by a user without write access

@pront pront enabled auto-merge July 15, 2025 16:08
@pront pront added this pull request to the merge queue Jul 21, 2025
Merged via the queue into vectordotdev:master with commit 144a0af Jul 21, 2025
42 checks passed
@esensar esensar deleted the docs/haversine branch July 21, 2025 14:48
5Dev24 pushed a commit to 5Dev24/vector that referenced this pull request Jul 21, 2025
@esensar @rtrieu
@pront @5Dev24
docs(external): add docs for haversine VRL function (vectordotdev#2…
61cf882 
…3336)

* docs(external): add docs for `haversine` VRL function

Related: vectordotdev/vrl#1442

* Apply suggestions from code review

Co-authored-by: Rosa Trieu <[email protected]>

* Rename haversine function in docs

* Add map category to docs

* Fix docs formatting

* Generate #FunctionCategory disjunction from list to reduce duplication

* Update names of arguments

* Update VRL

* Update VRL

* Update types for haversine in docs

---------

Co-authored-by: Rosa Trieu <[email protected]>
Co-authored-by: Pavlos Rontidis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pront pront pront approved these changes

@rtrieu rtrieu rtrieu approved these changes

Assignees

@pront pront

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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@esensar @pront @rtrieu