Modifications for ease of use#12
Open
StacieClark-Elastic wants to merge 1 commit intoelastic:mainfrom
Open
Conversation
…to cel.yml.hbs. Combined README.md files into one file.Reworked beats-config-from-agent-config-template.sh to use defaults and new directory structure
chrisberkhout
approved these changes
Dec 8, 2025
chrisberkhout
left a comment
There was a problem hiding this comment.
Good restructure.
I made a few comments.
Haven't been over everything in detail but this seems good to merge.
There was a problem hiding this comment.
A comment on a different file: LICENSE.
I think it'll need the Copyright [yyyy] [name of copyright owner] line to be filled out for Elastic.
| docker-compose file to run a mock server to serve an API so the example can | ||
| be run in realistically. The [README.md](./examples/README.md) explains how to | ||
| run the examples. | ||
| be run in realistically. The [README.md](./examples/README.md) explains how to |
|
|
||
| As a non-turing complete functional language, the structure of CEL programs can | ||
| seem foreign to procedural or object-oriented programmers. For more information | ||
| As a non-turing complete functional language, the structure of CEL programs can |
There was a problem hiding this comment.
Suggested change
| As a non-turing complete functional language, the structure of CEL programs can | |
| As a non-Turing complete functional language, the structure of CEL programs can |
Comment on lines
+46
to
+66
| scripts | ||
| ├── beats-config-from-agent-config-template.sh #script | ||
| ├── render.js #script that is used by | ||
| │ beats-config-from-agent-config-template.sh | ||
| └── filebeat-cel-input-base.yml #File for the filebeat cel-input file to | ||
| which the CEL progam will be added. | ||
| Can be any name. | ||
| examples | ||
| └──example_name/ # an example directory | ||
| ├── cel.yml.hbs # agent configuration file. * | ||
| ├── variables.yml # yaml file with replacement values for handlebar | ||
| │ handlebar variables in the cel.yml.hbs file. * | ||
| ├── filebeat/ # filebeat directory | ||
| │ ├── filebeat.yml # filebeat executable configuration file * | ||
| │ ├── inputs.d # generated directory to hold filebeat CEL input file * | ||
| │ │ └── test.yml # generated filebeat config. | ||
| │ └── out # generated directory for output * | ||
| └── docker/ # docker files to run a test API server | ||
| ├── docker-compose.yml | ||
| └── files | ||
| └── config.yml # contains responses from the API Server |
There was a problem hiding this comment.
Suggested change
| scripts | |
| ├── beats-config-from-agent-config-template.sh #script | |
| ├── render.js #script that is used by | |
| │ beats-config-from-agent-config-template.sh | |
| └── filebeat-cel-input-base.yml #File for the filebeat cel-input file to | |
| which the CEL progam will be added. | |
| Can be any name. | |
| examples | |
| └──example_name/ # an example directory | |
| ├── cel.yml.hbs # agent configuration file. * | |
| ├── variables.yml # yaml file with replacement values for handlebar | |
| │ handlebar variables in the cel.yml.hbs file. * | |
| ├── filebeat/ # filebeat directory | |
| │ ├── filebeat.yml # filebeat executable configuration file * | |
| │ ├── inputs.d # generated directory to hold filebeat CEL input file * | |
| │ │ └── test.yml # generated filebeat config. | |
| │ └── out # generated directory for output * | |
| └── docker/ # docker files to run a test API server | |
| ├── docker-compose.yml | |
| └── files | |
| └── config.yml # contains responses from the API Server | |
| . | |
| └── scripts/ | |
| ├── beats-config-from-agent-config-template.sh # Script. | |
| ├── render.js # Helper used by the script. | |
| └── filebeat-cel-input-base.yml # Filebeat CEL input config | |
| to which the CEL progam | |
| will be added. Can be any | |
| name. | |
| . | |
| └── examples/ | |
| └── example_name/ # An example directory. | |
| ├── cel.yml.hbs # Agent configuration file. * | |
| ├── variables.yml # YAML file with replacement values for | |
| │ Handlebars variables in the agent | |
| │ configuration file. * | |
| ├── filebeat/ # Filebeat directory. | |
| │ ├── filebeat.yml # Filebeat executable configuration file. * | |
| │ ├── inputs.d/ # Generated directory for Filebeat config. * | |
| │ │ └── test.yml # Generated Filebeat config. | |
| │ └── out/ # Generated directory for output. * | |
| └── docker/ # Docker files to run a test API server. | |
| ├── docker-compose.yml | |
| └── files/ | |
| └── config.yml # Contains responses from the API server. |
- Consistency in space after hash at start of description.
- Correct indentation of filebeat-cel-input-base.yml.
- Remove trailing whitespace.
- Consistency in period at end of description.
- Wrap lines to 80 chars.
- Same indentation level for all
examples/descriptions. - Consistency in trailing slash for directory names
- Initial capital for descriptions.
Comment on lines
+68
to
+72
| Files with an "*" after the description can have their name and location | ||
| overridden. The locations must be in sync with the 'filebeat.yml' specified | ||
| on the commandline when running 'filebeat'. This is an advanced use and not | ||
| expected in the normal flow of testing and debugging. | ||
| ``` |
There was a problem hiding this comment.
This paragraph could be moved outside of the directory tree code block.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changed directory structure. Changed names of all CEL template files to cel.yml.hbs. Combined README.md files into one file.Reworked beats-config-from-agent-config-template.sh to use defaults and new directory structure
Checklist
Related issues