Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
T
telegraf-nftables
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Due to inactivity, this project is scheduled to be deleted on 2035-04-24.
Why is this scheduled?
Show more breadcrumbs
vqgroup
telegraf-nftables
Commits
575a07c9
Unverified
Commit
575a07c9
authored
7 years ago
by
Daniel Nelson
Browse files
Options
Downloads
Patches
Plain Diff
Update input plugin example readme.
parent
b94cda6b
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
plugins/inputs/EXAMPLE_README.md
+21
-10
21 additions, 10 deletions
plugins/inputs/EXAMPLE_README.md
with
21 additions
and
10 deletions
plugins/inputs/EXAMPLE_README.md
+
21
−
10
View file @
575a07c9
...
@@ -6,30 +6,37 @@ additional information can be found.
...
@@ -6,30 +6,37 @@ additional information can be found.
### Configuration:
### Configuration:
This section contains the default TOML to configure the plugin. You can
generate it using
`telegraf --usage <plugin-name>`
.
```
toml
```
toml
# Description
# Description
[[inputs.example]]
[[inputs.example]]
# S
ample
Config
ex
ample
_option
=
"example_value"
```
```
### Me
asurements & Field
s:
### Me
tric
s:
Here you should add an optional description and links to where the user can
Here you should add an optional description and links to where the user can
get more information about the measurements.
get more information about the measurements.
If the output is determined dynamically based on the input source, or there
are more metrics than can reasonably be listed, describe how the input is
mapped to the output.
-
measurement1
-
measurement1
-
tags:
-
tag1 (optional description)
-
tag2
-
fields:
-
field1 (type, unit)
-
field1 (type, unit)
-
field2 (float, percent)
-
field2 (float, percent)
-
measurement2
-
field3 (integer, bytes)
### Tags:
-
measurement2
-
tags:
-
All measurements have the following tags:
-
tag1 (optional description)
-
tag2
-
measurement2 has the following tags:
-
tag3
-
tag3
-
fields:
-
field3 (integer, bytes)
### Sample Queries:
### Sample Queries:
...
@@ -44,6 +51,10 @@ SELECT max(field1), mean(field1), min(field1) FROM measurement1 WHERE tag1=bar A
...
@@ -44,6 +51,10 @@ SELECT max(field1), mean(field1), min(field1) FROM measurement1 WHERE tag1=bar A
### Example Output:
### Example Output:
This section shows example output in Line Protocol format. You can often use
`telegraf --input-filter <plugin-name> --test`
or use the
`file`
output to get
this information.
```
```
measurement1,tag1=foo,tag2=bar field1=1i,field2=2.1 1453831884664956455
measurement1,tag1=foo,tag2=bar field1=1i,field2=2.1 1453831884664956455
measurement2,tag1=foo,tag2=bar,tag3=baz field3=1i 1453831884664956455
measurement2,tag1=foo,tag2=bar,tag3=baz field3=1i 1453831884664956455
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment