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

[Serverless]: Clarify API key when using Logstash #167

Open
ppf2 opened this issue Nov 2, 2024 · 0 comments
Open

[Serverless]: Clarify API key when using Logstash #167

ppf2 opened this issue Nov 2, 2024 · 0 comments
Assignees
Labels
Serverless bug bash 🐛 Issues discovered during the Serverless UX bug bash

Comments

@ppf2
Copy link
Member

ppf2 commented Nov 2, 2024

Serverless Docs

Elasticsearch

Description

It can be helpful to enhance this section: https://www.elastic.co/docs/current/serverless/elasticsearch/ingest-data-through-logstash#api-keys-for-connecting-ls-to-es3

To include a screenshot to direct customers to select the API key format for Logstash:

Image

Some customers are attempting to use the base64 encoded form which is intended for REST API.

Even though we already have in-tool on-boarding for this on the Serverless Console, it can still be helpful to highlight this UI convenience feature to help them get the right format for the API Key for Logstash.

Additionally, since this helpful API key format feature is only available right after creating the API key from the UI (but not when managing existing API keys - an enhancement request we are discussing), we should also provide details on the expected API key format directly in the documentation. Specifically, Logstash expects the api_key to be in the format:

id:api_key

In order to construct the above format, the user will need to call GET API Key information API to obtain the id and then append their api_key value to it (https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html)

While we do have the following example in the doc:

output {
  elasticsearch {
    api_key => "TiNAGG4BaaMdaH1tRfuU:KnR6yE41RrSowb0kQ0HWoA"
  }
}

It will be helpful to explain the format and how to construct it.

Resources and additional context

https://www.elastic.co/docs/current/serverless/elasticsearch/ingest-data-through-logstash#api-keys-for-connecting-ls-to-es3

@georgewallace georgewallace added the Serverless bug bash 🐛 Issues discovered during the Serverless UX bug bash label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Serverless bug bash 🐛 Issues discovered during the Serverless UX bug bash
Projects
None yet
Development

No branches or pull requests

3 participants