Skip to content

Update help message for benchmark command #2585

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

Merged
merged 2 commits into from
Jun 13, 2025
Merged

Update help message for benchmark command #2585

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5615ca9
Update README
philippkahr May 9, 2025
f1a30f1
Add backticks into benchmark help message
mrodm Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Update README 
Formatting is weird when not wrapped in code block
  • Loading branch information
@philippkahr
philippkahr authored May 9, 2025
commit 5615ca95ccd090fae9ff798bb45bd6e797915536
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,10 +187,12 @@ For details on how to configure rally benchmarks for a package, review the [HOWT
These benchmarks allow you to benchmark ingesting real time data.
You can stream data to a remote ES cluster setting the following environment variables:

```
ELASTIC_PACKAGE_ELASTICSEARCH_HOST=https://my-deployment.es.eu-central-1.aws.foundit.no
ELASTIC_PACKAGE_ELASTICSEARCH_USERNAME=elastic
ELASTIC_PACKAGE_ELASTICSEARCH_PASSWORD=changeme
ELASTIC_PACKAGE_KIBANA_HOST=https://my-deployment.kb.eu-central-1.aws.foundit.no:9243
```
Comment on lines +190 to +195
Copy link
Contributor

@mrodm mrodm May 23, 2025

Choose a reason for hiding this comment

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

Hi @philippkahr,

This README file is generated automatically. In order to CI not fail because of that, you should update also this file:

elastic-package/cmd/benchmark.go

Lines 50 to 59 in f090440

#### Stream Benchmarks
These benchmarks allow you to benchmark ingesting real time data.
You can stream data to a remote ES cluster setting the following environment variables:
ELASTIC_PACKAGE_ELASTICSEARCH_HOST=https://my-deployment.es.eu-central-1.aws.foundit.no
ELASTIC_PACKAGE_ELASTICSEARCH_USERNAME=elastic
ELASTIC_PACKAGE_ELASTICSEARCH_PASSWORD=changeme
ELASTIC_PACKAGE_KIBANA_HOST=https://my-deployment.kb.eu-central-1.aws.foundit.no:9243

That is one of the files that are taken as a source to generate the main README.md

Copy link
Contributor

@mrodm mrodm Jun 13, 2025

Choose a reason for hiding this comment

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

Done in f1a30f1


#### System Benchmarks

Expand Down