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.

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

Adding JSON paths to FB ES module docs #12008

Merged
merged 4 commits into from
May 2, 2019
Merged

Adding JSON paths to FB ES module docs #12008

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
06b05e3
Adding JSON paths to FB ES module docs
ycombinator May 1, 2019
b4e1597
Adding note about ES version
ycombinator May 1, 2019
2a5b138
Apply suggestions from code review
dedemorton May 1, 2019
f062d3e
Remove mention of *_audit.log to avoid confusion
ycombinator May 2, 2019
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
32 changes: 27 additions & 5 deletions filebeat/docs/modules/elasticsearch.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,13 @@ Example config:
server:
enabled: true
var.paths:
- /var/log/elasticsearch/*.log
- /var/log/elasticsearch/*.log # Plaintext logs
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
- /var/log/elasticsearch/*_server.json # JSON logs
----
+
NOTE: If you running against Elasticsearch >= 7.0.0, configure your
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
`var.paths` setting to point to JSON logs. Otherwise, configure it
to point to plaintext logs.
ycombinator marked this conversation as resolved.
Show resolved Hide resolved

[float]
==== `gc` log fileset settings
Expand Down Expand Up @@ -70,8 +75,14 @@ Example config:
----
audit:
var.paths:
- /var/log/elasticsearch/*_audit.json
- /var/log/elasticsearch/*_access.log # Plaintext logs
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
- /var/log/elasticsearch/*_audit.log # JSON logs
Copy link
Member

Choose a reason for hiding this comment

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

Is this really in JSON format a the comment suffix suggests?

Copy link
Contributor Author

@ycombinator ycombinator May 2, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

Yes, this was the case in 6.7. Starting 7.0 the JSON audit logs were put into *_audit.json. I think, to avoid confusion and complexity, I'll just remove this line altogether.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed in f062d3e.

- /var/log/elasticsearch/*_audit.json # JSON logs
----
+
NOTE: If you running against Elasticsearch >= 7.0.0, configure your
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
`var.paths` setting to point to JSON logs. Otherwise, configure it
to point to plaintext logs.
ycombinator marked this conversation as resolved.
Show resolved Hide resolved

[float]
==== `slowlog` log fileset settings
Expand All @@ -84,9 +95,15 @@ Example config:
----
slowlog:
var.paths:
- /var/log/elasticsearch/*_index_search_slowlog.log
- /var/log/elasticsearch/*_index_indexing_slowlog.log
- /var/log/elasticsearch/*_index_search_slowlog.log # Plaintext logs
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
- /var/log/elasticsearch/*_index_indexing_slowlog.log # Plaintext logs
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
- /var/log/elasticsearch/*_index_search_slowlog.json # JSON logs
- /var/log/elasticsearch/*_index_indexing_slowlog.json # JSON logs
----
+
NOTE: If you running against Elasticsearch >= 7.0.0, configure your
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
`var.paths` setting to point to JSON logs. Otherwise, configure it
to point to plaintext logs.
ycombinator marked this conversation as resolved.
Show resolved Hide resolved

[float]
==== `deprecation` log fileset settings
Expand All @@ -99,8 +116,13 @@ Example config:
----
deprecation:
var.paths:
- /var/log/elasticsearch/*_deprecation.log
- /var/log/elasticsearch/*_deprecation.log # Plaintext logs
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
- /var/log/elasticsearch/*_deprecation.json # JSON logs
----
+
NOTE: If you running against Elasticsearch >= 7.0.0, configure your
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
`var.paths` setting to point to JSON logs. Otherwise, configure it
to point to plaintext logs.
ycombinator marked this conversation as resolved.
Show resolved Hide resolved

:has-dashboards!:

Expand Down
32 changes: 27 additions & 5 deletions filebeat/module/elasticsearch/_meta/docs.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,13 @@ Example config:
server:
enabled: true
var.paths:
- /var/log/elasticsearch/*.log
- /var/log/elasticsearch/*.log # Plaintext logs
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
- /var/log/elasticsearch/*_server.json # JSON logs
----
+
NOTE: If you running against Elasticsearch >= 7.0.0, configure your
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
`var.paths` setting to point to JSON logs. Otherwise, configure it
to point to plaintext logs.
ycombinator marked this conversation as resolved.
Show resolved Hide resolved

[float]
==== `gc` log fileset settings
Expand Down Expand Up @@ -65,8 +70,14 @@ Example config:
----
audit:
var.paths:
- /var/log/elasticsearch/*_audit.json
- /var/log/elasticsearch/*_access.log # Plaintext logs
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
- /var/log/elasticsearch/*_audit.log # JSON logs
Copy link
Member

Choose a reason for hiding this comment

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

Same as above - does this file contain JSON-formatted logs?

- /var/log/elasticsearch/*_audit.json # JSON logs
----
+
NOTE: If you running against Elasticsearch >= 7.0.0, configure your
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
`var.paths` setting to point to JSON logs. Otherwise, configure it
to point to plaintext logs.
ycombinator marked this conversation as resolved.
Show resolved Hide resolved

[float]
==== `slowlog` log fileset settings
Expand All @@ -79,9 +90,15 @@ Example config:
----
slowlog:
var.paths:
- /var/log/elasticsearch/*_index_search_slowlog.log
- /var/log/elasticsearch/*_index_indexing_slowlog.log
- /var/log/elasticsearch/*_index_search_slowlog.log # Plaintext logs
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
- /var/log/elasticsearch/*_index_indexing_slowlog.log # Plaintext logs
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
- /var/log/elasticsearch/*_index_search_slowlog.json # JSON logs
- /var/log/elasticsearch/*_index_indexing_slowlog.json # JSON logs
----
+
NOTE: If you running against Elasticsearch >= 7.0.0, configure your
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
`var.paths` setting to point to JSON logs. Otherwise, configure it
to point to plaintext logs.
ycombinator marked this conversation as resolved.
Show resolved Hide resolved

[float]
==== `deprecation` log fileset settings
Expand All @@ -94,8 +111,13 @@ Example config:
----
deprecation:
var.paths:
- /var/log/elasticsearch/*_deprecation.log
- /var/log/elasticsearch/*_deprecation.log # Plaintext logs
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
- /var/log/elasticsearch/*_deprecation.json # JSON logs
----
+
NOTE: If you running against Elasticsearch >= 7.0.0, configure your
ycombinator marked this conversation as resolved.
Show resolved Hide resolved
`var.paths` setting to point to JSON logs. Otherwise, configure it
to point to plaintext logs.
ycombinator marked this conversation as resolved.
Show resolved Hide resolved

:has-dashboards!:

Expand Down