Skip to content

Commit

Permalink
Update README.md and example log section (#5898)
Browse files Browse the repository at this point in the history
* Update README.md log section

* Clean up conf.yaml.example

* Fix typo

* Uncomment logs section

* Update tenable/README.md

Co-Authored-By: Florimond Manca <[email protected]>

Co-authored-by: Florimond Manca <[email protected]>
  • Loading branch information
AlexandreYang and florimondmanca authored Feb 27, 2020
1 parent d0a3eba commit 1ea360d
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 30 deletions.
36 changes: 30 additions & 6 deletions tenable/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,45 @@ Follow the instructions below configure this integration for an Agent running on

To install the Tenable integration configuration on your Agent:

**Note**: This step will not be necessary in the next Agent version
**Note**: This step will not be necessary for Agent version >= 7.18.0.

1. [Install][2] the 1.0 release (`tenable==1.0.0`).

### Configuration

1. Edit the `tenable.d/conf.yaml` file, in the `conf.d/` folder at the root of your Agent's configuration directory to start collecting your Tenable nessus logs. See the [sample tenable.d/conf.yaml][3] for available configuration options.
The Agent tails the Tenable Nessus `webserver` and `backend` logs to collect data on Nessus scans.

2. [Restart the Agent][4].
#### Log collection

## Data Collected
_Available for Agent versions >6.0_

### Logs
1. Collecting logs is disabled by default in the Datadog Agent, enable it in your `datadog.yaml` file:

```yaml
logs_enabled: true
```
2. Uncomment and edit this configuration block at the bottom of your `tenable.d/conf.yaml`:

See the [sample tenable.d/conf.yaml][3] for available configuration options.

```yaml
logs:
- type: file
path: /opt/nessus/var/nessus/logs/backend.log
service: nessus_backend
source: tenable
- type: file
path: /opt/nessus/var/nessus/logs/www_server.log
service: nessus_webserver
source: tenable
```

Customize the `path` and `service` parameter values if necessary for your environment.

3. [Restart the Agent][7].

The agent tails the Tenable nessus `webserver` and `backend` logs to collect data on nessus scans

### Metrics

Expand Down
35 changes: 11 additions & 24 deletions tenable/datadog_checks/tenable/data/conf.yaml.example
Original file line number Diff line number Diff line change
@@ -1,16 +1,3 @@
init_config:

instances:
-
## @param tags - list of key:value elements - optional
## List of tags to attach to every metric, event and service check emitted by this integration.
##
## Learn more about tagging: https://docs.datadoghq.com/tagging/
#
# tags:
# - <KEY_1>:<VALUE_1>
# - <KEY_2>:<VALUE_2>

## Log Section (Available for Agent >=6.0)
##
## type - mandatory - Type of log input source (tcp / udp / file / windows_event)
Expand All @@ -21,14 +8,14 @@ instances:
## tags: - optional - Add tags to the collected logs
##
## Discover Datadog log collection: https://docs.datadoghq.com/logs/log_collection/
#
# logs:
# - type: file
# path: /opt/nessus/var/nessus/logs/backend.log
# service: nessus_backend
# source: tenable
#
# - type: file
# path: /opt/nessus/var/nessus/logs/www_server.log
# service: nessus_webserver
# source: tenable

logs:
- type: file
path: /opt/nessus/var/nessus/logs/backend.log
service: nessus_backend
source: tenable

- type: file
path: /opt/nessus/var/nessus/logs/www_server.log
service: nessus_webserver
source: tenable

0 comments on commit 1ea360d

Please sign in to comment.