53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
# Port Name Lookup Processor Plugin
|
|
|
|
Use the `port_name` processor to convert a tag or field containing a well-known
|
|
port number to the registered service name.
|
|
|
|
Tag or field can contain a number ("80") or number and protocol separated by
|
|
slash ("443/tcp"). If protocol is not provided it defaults to tcp but can be
|
|
changed with the default_protocol setting. An additional tag or field can be
|
|
specified for the protocol.
|
|
|
|
If the source was found in tag, the service name will be added as a tag. If the
|
|
source was found in a field, the service name will also be a field.
|
|
|
|
Telegraf minimum version: Telegraf 1.15.0
|
|
|
|
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
|
|
|
|
In addition to the plugin-specific configuration settings, plugins support
|
|
additional global and plugin configuration settings. These settings are used to
|
|
modify metrics, tags, and field or create aliases and configure ordering, etc.
|
|
See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
|
|
|
|
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
|
|
|
|
## Configuration
|
|
|
|
```toml @sample.conf
|
|
# Given a tag/field of a TCP or UDP port number, add a tag/field of the service name looked up in the system services file
|
|
[[processors.port_name]]
|
|
## Name of tag holding the port number
|
|
# tag = "port"
|
|
## Or name of the field holding the port number
|
|
# field = "port"
|
|
|
|
## Name of output tag or field (depending on the source) where service name will be added
|
|
# dest = "service"
|
|
|
|
## Default tcp or udp
|
|
# default_protocol = "tcp"
|
|
|
|
## Tag containing the protocol (tcp or udp, case-insensitive)
|
|
# protocol_tag = "proto"
|
|
|
|
## Field containing the protocol (tcp or udp, case-insensitive)
|
|
# protocol_field = "proto"
|
|
```
|
|
|
|
## Example
|
|
|
|
```diff
|
|
- measurement,port=80 field=123 1560540094000000000
|
|
+ measurement,port=80,service=http field=123 1560540094000000000
|
|
```
|