Skip to content

Doc: Set version attribute in plugin source file #308

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 5 commits into from
May 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## Unreleased
## 4.4.1
- Fix: update to Gradle 7 [#305](https://github.com/logstash-plugins/logstash-input-file/pull/305)
- [DOC] Add version attributes to doc source file [#308](https://github.com/logstash-plugins/logstash-input-file/pull/308)

## 4.4.0
- Add support for ECS v8 [#301](https://github.com/logstash-plugins/logstash-input-file/pull/301)
Expand Down
18 changes: 14 additions & 4 deletions docs/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ START - GENERATED VARIABLES, DO NOT EDIT!
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include

ifeval::["{versioned_docs}"=="true"]
:branch: %BRANCH%
:ecs_version: %ECS_VERSION%
endif::[]
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
Expand Down Expand Up @@ -82,7 +87,7 @@ was not ideal and a dedicated Read mode is an improvement.
==== Compatibility with the Elastic Common Schema (ECS)

This plugin adds metadata about event's source, and can be configured to do so
in an {ecs-ref}[ECS-compatible] way with <<plugins-{type}s-{plugin}-ecs_compatibility>>.
in an https://www.elastic.co/guide/en/ecs/{ecs_version}/index.html[ECS-compatible] way with <<plugins-{type}s-{plugin}-ecs_compatibility>>.
This metadata is added after the event has been decoded by the appropriate codec,
and will never overwrite existing values.

Expand Down Expand Up @@ -270,7 +275,7 @@ In practice, this will be the best case because the time taken to read new conte
** Otherwise, the default value is `disabled`.

Controls this plugin's compatibility with the
{ecs-ref}[Elastic Common Schema (ECS)].
https://www.elastic.co/guide/en/ecs/{ecs_version}/index.html[Elastic Common Schema (ECS)].

[id="plugins-{type}s-{plugin}-exclude"]
===== `exclude`
Expand Down Expand Up @@ -426,7 +431,7 @@ of `/var/log` will be done for all `*.log` files.
Paths must be absolute and cannot be relative.

You may also configure multiple paths. See an example
on the {logstash-ref}/configuration-file-structure.html#array[Logstash configuration page].
on the https://www.elastic.co/guide/en/logstash/{branch}/configuration-file-structure.html#array[Logstash configuration page].

[id="plugins-{type}s-{plugin}-sincedb_clean_after"]
===== `sincedb_clean_after`
Expand All @@ -439,7 +444,7 @@ The sincedb record now has a last active timestamp associated with it.
If no changes are detected in a tracked file in the last N days its sincedb
tracking record expires and will not be persisted.
This option helps protect against the inode recycling problem.
Filebeat has a {filebeat-ref}/inode-reuse-issue.html[FAQ about inode recycling].
Filebeat has an https://www.elastic.co/guide/en/beats/filebeat/{branch}}/inode-reuse-issue.html[FAQ about inode recycling].

[id="plugins-{type}s-{plugin}-sincedb_path"]
===== `sincedb_path`
Expand Down Expand Up @@ -533,4 +538,9 @@ Supported values: `us` `usec` `usecs`, e.g. "600 us", "800 usec", "900 usecs"
[NOTE]
`micro` `micros` and `microseconds` are not supported

ifeval::["{versioned_docs}"=="true"]
:branch: current
:ecs_version: current
endif::[]

:default_codec!:
2 changes: 1 addition & 1 deletion logstash-input-file.gemspec
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Gem::Specification.new do |s|

s.name = 'logstash-input-file'
s.version = '4.4.0'
s.version = '4.4.1'
s.licenses = ['Apache-2.0']
s.summary = "Streams events from files"
s.description = "This gem is a Logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gemname. This gem is not a stand-alone program"
Expand Down