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

Initialize docs for functionbeat #8744

Merged
merged 10 commits into from
Nov 9, 2018

Conversation

dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Oct 25, 2018

Initial commit with docs for functionbeat. This is a work in progress (not ready to merge).

Todo after merging:

  • Add an FAQ topic that explains that you need to deploy functionbeat in the same region where the services (cloud watch logs/sqs) you're monitoring are deployed.
  • Should we say anything about checking for problems in the logs for the function, or is that stating the obvious?
  • Remove the following topics because they are not relevant to functionbeat:
    • Set up project paths: Nothing can be really change in provider container.
    • HTTP Endpoint: This will not be accessible
    • FAQ topics that aren't relevant:
      • Logstash connection doesn’t work?
      • Need to limit bandwidth used by Functionbeat?
      • @metadata is missing in Logstash? SSL client fails to connect to Logstash?
    • The following sections under security because they are not relevant to functionbeat:
      • Secure communication with Logstash by using SSL
      • Use Linux Secure Computing Mode (seccomp)
    • Topic about Repositories for APT and YUM
  • Change logging topic to indicate where that the logs are only available in the cloudwatch log group of the functionbeat lambda. Maybe mention AWS panel.

@dedemorton dedemorton added docs in progress Pull request is currently in progress. labels Oct 25, 2018
@ph ph self-requested a review October 25, 2018 13:05
@dedemorton dedemorton added the needs_backport PR is waiting to be backported to other branches. label Nov 1, 2018
libbeat/docs/command-reference.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/config-options.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/configuring-howto.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/overview.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/running-on-docker.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/how-it-works.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
@ph
Copy link
Contributor

ph commented Nov 1, 2018

@dedemorton I did a first pass on this PR, ping me for any followup.

@dedemorton
Copy link
Contributor Author

@ph I've made most of your changes (and marked them as resolved), but I won't push the updates until I've tested and made more updates. I have a couple of follow up questions in the mean time.

@dedemorton dedemorton force-pushed the add_functionbeat_docs branch 2 times, most recently from bd2ddd1 to 824b8d7 Compare November 3, 2018 02:39
@dedemorton dedemorton removed the in progress Pull request is currently in progress. label Nov 8, 2018
@dedemorton
Copy link
Contributor Author

@ph Pushed some changes. This is ready for another review.

x-pack/functionbeat/docs/config-options.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/config-options.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/filtering.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/filtering.asciidoc Show resolved Hide resolved
x-pack/functionbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
x-pack/functionbeat/docs/getting-started.asciidoc Outdated Show resolved Hide resolved
@ph ph added the Functionbeat label Nov 8, 2018
@dedemorton
Copy link
Contributor Author

@ph I've resolved all the issues you identified. I still need to hear back about the download path. I've uploaded the files to firebase if you want to see the rendered docs without having to build them: https://functionbeat-ad51b.firebaseapp.com/

@ph
Copy link
Contributor

ph commented Nov 9, 2018

@dedemorton It is possible to remove the Repositories for APT and YUM in the getting started section of functionbeat?

Copy link
Contributor

@ph ph left a comment

Choose a reason for hiding this comment

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

@dedemorton Yeah the docs are beta, I think the main problem is to remove stuff that doesn't apply to functionbeat :(

Can we filter out some items from the FAQ https://functionbeat-ad51b.firebaseapp.com/faq.html?
I think the items below are not really related to functionbeat.

  • Logstash connection doesn’t work?
  • Need to limit bandwidth used by Functionbeat?
  • @metadata is missing in Logstash?
  • SSL client fails to connect to Logstash?

The logging section, we will need to adjust that, all the selectors are valid, the log level is valid, changing where the log need to be is invalid, since the log are only available in the cloudwatch log group of the functionbeat lambda.

x-pack/functionbeat/docs/index.asciidoc Show resolved Hide resolved

A regular expression that matches the events you want to collect. Setting this
option may reduce execution costs because the function running the Beat
only executes if there is data that matches the pattern.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add the options from https://github.com/elastic/beats/blob/master/x-pack/functionbeat/functionbeat.reference.yml

    # Concurrency, is the reserved number of instances for that function.
    # Default is unreserved.
    #
    # Note: There is a hard limit of 1000 functions of any kind per account.
    #concurrency: 5

    # The maximum memory allocated for this function, the configured size must be a factor of 64.
    # There is a hard limit of 3008MiB for each function. Default is 128MiB.
    #memory_size: 128MiB

    # Dead letter queue configuration, this must be set to an ARN pointing to a SQS queue.
#dead_letter_config.target_arn:

Concurrency is the most important, this is the option to control your cost, by default in the initial release we run in an unreserved way, but 6.5.1 we will use a default of 5.

@dedemorton dedemorton force-pushed the add_functionbeat_docs branch from 298bf95 to 18df973 Compare November 9, 2018 19:57
@dedemorton dedemorton merged commit 1d6d47a into elastic:master Nov 9, 2018
dedemorton added a commit to dedemorton/beats that referenced this pull request Nov 9, 2018
* Initialize docs

* Run make update

* In progress fixes from review

* More changes from the review and testing

* Add fixes from the review

* Fixed download path

* Remove unused dashboard image placeholders

* Add missing options and remove boiler plate text

* Run make update

* Remove broken link
dedemorton added a commit to dedemorton/beats that referenced this pull request Nov 9, 2018
* Initialize docs

* Run make update

* In progress fixes from review

* More changes from the review and testing

* Add fixes from the review

* Fixed download path

* Remove unused dashboard image placeholders

* Add missing options and remove boiler plate text

* Run make update

* Remove broken link
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Nov 9, 2018
dedemorton added a commit that referenced this pull request Nov 12, 2018
* Add conditions for each platform (#8811)

* Add conditions for each platform

* Add conditions to directory layout topic

* Combine conditions for deb and rpm

* Update Journalbeat docs (#8864)

* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back

* Initialize docs for functionbeat (#8744)

* Initialize docs

* Run make update

* In progress fixes from review

* More changes from the review and testing

* Add fixes from the review

* Fixed download path

* Remove unused dashboard image placeholders

* Add missing options and remove boiler plate text

* Run make update

* Remove broken link
dedemorton added a commit that referenced this pull request Nov 12, 2018
* Add conditions for each platform (#8811)

* Add conditions for each platform

* Add conditions to directory layout topic

* Combine conditions for deb and rpm

* Update Journalbeat docs (#8864)

* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back

* Initialize docs for functionbeat (#8744)

* Initialize docs

* Run make update

* In progress fixes from review

* More changes from the review and testing

* Add fixes from the review

* Fixed download path

* Remove unused dashboard image placeholders

* Add missing options and remove boiler plate text

* Run make update

* Remove broken link
DStape pushed a commit to DStape/beats that referenced this pull request Aug 20, 2019
…tic#8744) (elastic#9024)

* Add conditions for each platform (elastic#8811)

* Add conditions for each platform

* Add conditions to directory layout topic

* Combine conditions for deb and rpm

* Update Journalbeat docs (elastic#8864)

* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back

* Initialize docs for functionbeat (elastic#8744)

* Initialize docs

* Run make update

* In progress fixes from review

* More changes from the review and testing

* Add fixes from the review

* Fixed download path

* Remove unused dashboard image placeholders

* Add missing options and remove boiler plate text

* Run make update

* Remove broken link
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
…tic#8744)  (elastic#9025)

* Add conditions for each platform (elastic#8811)

* Add conditions for each platform

* Add conditions to directory layout topic

* Combine conditions for deb and rpm

* Update Journalbeat docs (elastic#8864)

* More updates for journalbeat

* Remove unwanted comments and extra files

* Add changes from review

* Changes from second round of reviews

* Remove backoff options

* Remove questions for reviewers

* Change file to journal

* Change default  max_backoff in docs to 20s

* More fixes from review

* Revert "Remove backoff options"

This reverts commit d57e4b3.

* Add global options back

* Initialize docs for functionbeat (elastic#8744)

* Initialize docs

* Run make update

* In progress fixes from review

* More changes from the review and testing

* Add fixes from the review

* Fixed download path

* Remove unused dashboard image placeholders

* Add missing options and remove boiler plate text

* Run make update

* Remove broken link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants