-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Conversation
@dedemorton I did a first pass on this PR, ping me for any followup. |
@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. |
bd2ddd1
to
824b8d7
Compare
@ph Pushed some changes. This is ready for another review. |
@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/ |
@dedemorton It is possible to remove the |
There was a problem hiding this 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 :(
- I found a Keystore issue at Functionbeat: Keystore file is missing when we deploy the beat on the serverless env. #9009
- I see 2 kibana screen shot in the PR, where they are used?
- I would remove section about
Set up project paths
: Nothing can be really change in provider container. - Remove section
HTTP Endpoint
: This will not be accessible
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.
|
||
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. |
There was a problem hiding this comment.
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.
298bf95
to
18df973
Compare
* 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
* 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
* 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
* 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
…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
…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
Initial commit with docs for functionbeat. This is a work in progress (not ready to merge).
Todo after merging: