-
Notifications
You must be signed in to change notification settings - Fork 159
[Observability] Add log data sources page #1791
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
18 commits
Select commit
Hold shift + click to select a range
fe5c44d
add logs sources page
mdbirnstiehl d5ddfde
update toc
mdbirnstiehl fa650ed
Merge branch 'main' into log-data-sources
mdbirnstiehl 32d4bf0
update API steps
mdbirnstiehl 500c8ee
fix link
mdbirnstiehl ae41917
fix link
mdbirnstiehl 525433a
actually fix links
mdbirnstiehl 95942bc
Merge branch 'main' into log-data-sources
mdbirnstiehl e5bf3b2
update API steps
mdbirnstiehl cbc452c
fix link
mdbirnstiehl 5a6f2b3
update steps
mdbirnstiehl 0783b95
fix typo
mdbirnstiehl 2894465
fix wording
mdbirnstiehl eb660eb
update note
mdbirnstiehl c6325e9
fix applies to
mdbirnstiehl 788a4b2
update import instructions
mdbirnstiehl e4b6692
Update solutions/observability/logs/log-data-sources.md
mdbirnstiehl 0457764
Merge branch 'main' into log-data-sources
mdbirnstiehl File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
applies_to: | ||
stack: all | ||
serverless: all | ||
products: | ||
- id: observability | ||
--- | ||
|
||
# Configure log data sources | ||
|
||
The `observability:logSources` {{kib}} advanced setting defines which index patterns your deployment or project uses to store and query log data. | ||
|
||
Configure this setting at **Stack Management** → **Advanced Settings** or by searching for `Advanced Settings` in the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md). | ||
|
||
|
||
::::{note} | ||
Adding indices to the `observability:logSources` setting that don't contain log data may cause degraded functionality. Changes to this setting can also impact the sources queried by log threshold rules. | ||
:::: | ||
|
||
## Configure log data sources using the `saved_objects` API | ||
|
||
To configure log data sources using an API, use the `saved_objects` API. To do this, | ||
|
||
1. From **Stack Management** → **Saved Objects**, [export](/explore-analyze/find-and-organize/saved-objects.md) the log data views, which are stored as an `infrastructure-monitoring-log-view` saved object type, to use as a template. | ||
1. Modify the relevant data view fields in the exported JSON. | ||
1. Import the saved object using the [import saved objects API]({{kib-apis}}/operation/operation-importsavedobjectsdefault). | ||
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
Oops, something went wrong.
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.
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.
@weltenwort I pulled these instructions from a comment you made on an older issue from last year. I was hoping you could take a look and make sure this is still applicable or if there are changes that need to be made?
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.
Hi @mdbirnstiehl, thanks for the ping. This approach makes sense for existing deployments that don't use advanced setting mentioned above for historic reasons. Any newer deployments default to using the advanced setting and a manipulation of the log view saved object might therefore not have any effect. AFAIK in serverless that saved object type doesn't exist at all.
So if we want to include this approach I feel we should add lots of caveat warnings around it. Does that help?
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.
Thanks @weltenwort, that does make sense. There's a discussion in the issue for this PR, where I think what we actually want to document is using the Advanced Settings saved object. I'm not sure if the process to use Advanced Settings saved object would be similar to this or if the process would differ.
Uh oh!
There was an error while loading. Please reload this page.
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.
The process would be similar, but the downside is that one couldn't just export/import this one setting selectively. It would always apply to all settings.
For users that use configuration management for Kibana deployments, there is the option to define overrides to individual settings in the yaml file like this:
But I'm not sure if that is an officially supported setting or not 🤔