Skip to content

Doc: Add clarification about API key format for Logstash #17688

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

vishaangelova
Copy link
Contributor

@vishaangelova vishaangelova commented May 26, 2025

Release notes

[rn:skip]

What does this PR do?

This PR clarifies the API key format required for Logstash in the following docs:

  • docs/reference/secure-connection.md
  • docs/reference/connecting-to-cloud.md
  • docs/reference/using-logstash-with-elastic-integrations.md

Related issues

Closes #17687

Changes

(All links are to the PR preview)

Previews

https://docs-v3-preview.elastic.dev/elastic/logstash/pull/17688/reference
https://docs-v3-preview.elastic.dev/elastic/logstash/pull/17688/reference/secure-connection
https://docs-v3-preview.elastic.dev/elastic/logstash/pull/17688/reference/connecting-to-cloud
https://docs-v3-preview.elastic.dev/elastic/logstash/pull/17688/reference/using-logstash-with-elastic-integrations

@vishaangelova vishaangelova added enhancement docs backport-active-9 Automated backport with mergify to all the active 9.[0-9]+ branches labels May 26, 2025
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@karenzone
Copy link
Contributor

Looking...

@@ -19,7 +19,7 @@ Logstash accelerates your insights by harnessing a greater volume and variety of
You’ll use the {{ls}} [{{es}} output plugin](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md) to send data to {{serverless-full}}.
Note these differences between {{es-serverless}} and both {{ess}} and self-managed {{es}}:

* Use **API keys** to access {{serverless-full}} from {{ls}}. Any user-based security settings in your [{{es}} output plugin](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md) configuration are ignored and may cause errors.
* Use [**API keys**](/reference/secure-connection.md#ls-api-keys) to access {{serverless-full}} from {{ls}}. Any user-based security settings in your [{{es}} output plugin](logstash-docs-md://lsr/plugins-outputs-elasticsearch.md) configuration are ignored and may cause errors.
Copy link
Contributor

Choose a reason for hiding this comment

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

We can also be more direct and say that Serverless does not support native user authentication. You must use API keys to access Serverless.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-active-9 Automated backport with mergify to all the active 9.[0-9]+ branches docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Serverless]: Clarify API key when using Logstash
3 participants