Skip to content

file() and wildcard-file() sources #202

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
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: 3 additions & 0 deletions _includes/doc/admin-guide/notes/wildcard-option-warning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
**NOTE:**
This option is only available for the `wildcard-file()` source but unavailable for the `file()` source.
{: .notice--info}
50 changes: 0 additions & 50 deletions doc/_admin-guide/060_Sources/020_File/000_File_source_options.md

This file was deleted.

10 changes: 6 additions & 4 deletions doc/_admin-guide/060_Sources/020_File/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: 'file: Collecting messages from text files (DEPRECATED)'
short_title: file (DEPRECATED)
title: 'file: Collecting messages from text files'
short_title: file
id: adm-src-file
description: >-
The file() source has been deprecated. For a more stable performance, use the [[wildcard-file() source|adm-src-wild]] instead. Collects log messages from plain-text files, for example, from the logfiles of
an Apache webserver. If you want to use wildcards in the filename, use the [[wildcard-file() source|adm-src-wild]].
Collects log messages from plain-text files, for example, from the logfiles of
an Apache webserver. If you want to use wildcards in the filename, use the [[wildcard-file() source|adm-src-wild]]. Currently, {{ site.product.short_name }} supports the file() source to maintain certain compatibilities, but it is advised to use the wildcard-file() source for longevity reasons and more configuration options.
---

The {{ site.product.short_name }} application notices if a file is renamed or replaced with
Expand Down Expand Up @@ -49,3 +49,5 @@ treats messages received from files as sent by the kern facility. Use
the **default-facility()** and **default-priority()** options in the
source definition to assign a different facility if needed.
{: .notice--info}

For the configuration options available in the `file()` source, see wildcard-file() source options.
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ The wildcard-file() driver has the following options:

## base-dir()

{% include doc/admin-guide/notes/wildcard-option-warning.md %}

|Type:| path without filename|
|Default:||

Expand Down Expand Up @@ -39,6 +41,8 @@ source s_files {

## filename-pattern()

{% include doc/admin-guide/notes/wildcard-option-warning.md %}

|Type:|filename without path|
|Default:||

Expand Down