Skip to content

Adding rate limit processor doc to processors list#23096

Merged
ycombinator merged 3 commits intoelastic:masterfrom
ycombinator:lb-processor-rate-limit-doc
Dec 15, 2020
Merged

Adding rate limit processor doc to processors list#23096
ycombinator merged 3 commits intoelastic:masterfrom
ycombinator:lb-processor-rate-limit-doc

Conversation

@ycombinator
Copy link
Copy Markdown
Contributor

@ycombinator ycombinator commented Dec 14, 2020

What does this PR do?

Adds the rate_limit processor document to the list of processors document. This was missed in #22883 and thanks to @jsoriano for pointing it out.

Why is it important?

So the rate_limit processor's documentation is discoverable to users.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Dec 14, 2020
@ycombinator ycombinator added the Team:Platforms Label for the Integrations - Platforms team label Dec 14, 2020
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Dec 14, 2020
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Dec 14, 2020

Pinging @elastic/integrations-platforms (Team:Platforms)

@ycombinator ycombinator mentioned this pull request Dec 14, 2020
Merged
6 tasks
@ycombinator
Copy link
Copy Markdown
Contributor Author

ycombinator commented Dec 14, 2020

Hey @dedemorton, I'm trying to run make docs on this PR from the root folder of my beats repo checkout. I'm getting the following error.

development/github/beats ‹lb-processor-rate-limit-doc*› » make docs
Cloning into '/Users/shaunak/development/github/beats/build/docs'...
remote: Enumerating objects: 548, done.
remote: Counting objects: 100% (548/548), done.
remote: Compressing objects: 100% (476/476), done.
remote: Total 548 (delta 54), reused 301 (delta 20), pack-reused 0
Receiving objects: 100% (548/548), 41.51 MiB | 11.69 MiB/s, done.
Resolving deltas: 100% (54/54), done.
Building docs for libbeat...
Index document: /Users/shaunak/go/src/github.com/elastic/beats/libbeat/docs/index.asciidoc
Index path: docs
Destination directory: /Users/shaunak/development/github/beats/build/html_docs/libbeat/docs
Can't mount two repos with the same name [beats]
make[1]: *** [docs] Error 1
make: *** [docs] Error 1

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Dec 14, 2020 •
edited by jenkins-beats-ci bot
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: Pull request #23096 updated

  • Start Time: 2020-12-15T01:57:41.824+0000

  • Duration: 10 min 37 sec

❕ Flaky test report

No test was executed to be analysed.

dedemorton
dedemorton reviewed Dec 14, 2020
View reviewed changes
libbeat/docs/processors-list.asciidoc
* <<include-fields,`include_fields`>>
endif::[]
ifndef::no_include_rate_limit_processor[]
* <<rate-limit,`rate_limit`>>
Copy link
Copy Markdown
Contributor

@dedemorton dedemorton Dec 14, 2020

Choose a reason for hiding this comment

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

This line just adds a link. To fix the doc build error, you also need to add the include in the correct location under //# tag::processors-include[]

Copy link
Copy Markdown
Contributor

@dedemorton dedemorton Dec 14, 2020

Choose a reason for hiding this comment

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

Specifically, you want to add this to the correct location (alphabetically) in the list of includes:

ifndef::no_include_rate_limit_processor[]
include::{libbeat-processors-dir}/ratelimit/docs/rate_limit.asciidoc[]
endif::[]

Copy link
Copy Markdown
Contributor Author

@ycombinator ycombinator Dec 15, 2020

Choose a reason for hiding this comment

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

Thanks, fixed in a31b5ac.

@dedemorton
Copy link
Copy Markdown
Contributor

dedemorton commented Dec 14, 2020

Regarding:

I'm trying to run make docs on this PR from the root folder of my beats repo checkout. I'm getting the following error.

I get a totally different error when I run make docs from the beats directory:

mage docs
Error parsing magefiles: error running "go list -f {{.Dir}}||{{.Name}} github.com/elastic/beats/v7/dev-tools/mage/target/build": exit status 1
can't load package: package github.com/elastic/beats/v7/dev-tools/mage/target/build: cannot find package "github.com/elastic/beats/v7/dev-tools/mage/target/build" in any of:
	/usr/local/go/src/github.com/elastic/beats/v7/dev-tools/mage/target/build (from $GOROOT)
	/Users/dedemorton/go/src/github.com/elastic/beats/v7/dev-tools/mage/target/build (from $GOPATH)
make[1]: *** [docs] Error 1

However, when I change to a specific directory, it works.

I'm not sure what has changed, but I can't help you. This sounds like a bug in the scripts. Maybe ask in the beats slack channel if you haven't already?

jsoriano
jsoriano approved these changes Dec 15, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@jsoriano jsoriano left a comment

Choose a reason for hiding this comment

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

Preview in docs build looks good 👍

@jsoriano jsoriano added needs_backport PR is waiting to be backported to other branches. v7.11.0 v7.12.0 labels Dec 15, 2020
@ycombinator ycombinator merged commit 125ff1d into elastic:master Dec 15, 2020
@ycombinator ycombinator deleted the lb-processor-rate-limit-doc branch December 15, 2020 12:08
@ycombinator ycombinator mentioned this pull request Dec 15, 2020
Merged
@ycombinator ycombinator added v8.0.0 and removed needs_backport PR is waiting to be backported to other branches. v7.12.0 labels Dec 15, 2020
ycombinator added a commit that referenced this pull request Dec 15, 2020
@ycombinator
Adding rate limit processor doc to processors list (#23096) (#23143)
c1154eb 
* Adding rate limit processor doc to processors list

* Fixing ID

* Include processor in included processors list
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jsoriano jsoriano jsoriano approved these changes

@dedemorton dedemorton Awaiting requested review from dedemorton

Assignees

No one assigned

Labels

docs Team:Platforms Label for the Integrations - Platforms team v7.11.0 v8.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@ycombinator @elasticmachine @dedemorton @jsoriano @andresrc