Skip to content
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.

Sign up for GitHub

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

Jump to bottom

doc(known-issues): memory leak in 6.2.x #71

Merged
merged 2 commits into from
Mar 16, 2021
Merged

doc(known-issues): memory leak in 6.2.x #71

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c782837
doc(known-issues): memory leak in 6.2.x
bluecmd Mar 16, 2021
0fd541d
doc(readme): Reformat and add ToC
bluecmd Mar 16, 2021
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
27 changes: 22 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@

Prometheus exporter for Fortigate firewalls.

* [Supported Metrics](#supported-metrics)
* [Usage](#usage)
+ [Available CLI parameters](#available-cli-parameters)
+ [Fortigate Configuration](#fortigate-configuration)
+ [Prometheus Configuration](#prometheus-configuration)
+ [Docker](#docker)
- [docker-compose](#docker-compose)
* [Known Issues](#known-issues)
* [Missing Metrics?](#missing-metrics)

## Supported Metrics

Right now the exporter supports a quite limited set of metrics, but it is very easy to add!
Expand Down Expand Up @@ -122,7 +132,7 @@ which means that currently you need HTTPS to be configured properly.

To probe a Fortigate, do something like `curl 'localhost:9710/probe?target=https://my-fortigate'`

## Available CLI parameters
### Available CLI parameters
| flag | default value | description |
|---|---|---|
| -auth-file | /config/fortigate-key.yaml | path to the location of the key file |
Expand All @@ -132,7 +142,7 @@ To probe a Fortigate, do something like `curl 'localhost:9710/probe?target=https
| -insecure | false | allows to turn off security validation of TLS certificates |
| -extra-ca-certs | (none) | comma-separated files containing extra PEMs to trust for TLS connections in addition to the system trust store |

## Fortigate Configuration
### Fortigate Configuration

The following example Admin Profile describes the permissions that needs to be granted
to the monitor user in order for all metrics to be available.
Expand Down Expand Up @@ -169,7 +179,7 @@ config system accprofile
end
```

## Prometheus Configuration
### Prometheus Configuration

An example configuration for Prometheus looks something like this:

Expand All @@ -191,7 +201,7 @@ An example configuration for Prometheus looks something like this:
replacement: '[::1]:9710'
```

## Docker
### Docker

You can either use the automatic builds on
[quay.io](https://quay.io/repository/bluecmd/fortigate_exporter) or build yourself
Expand All @@ -202,7 +212,7 @@ docker build -t fortigate_exporter .
docker run -d -p 9710:9710 -v /path/to/fortigate-key.yaml:/config/fortigate-key.yaml fortigate_exporter
```

### docker-compose
#### docker-compose

```yaml
prometheus_fortigate_exporter:
Expand All @@ -216,6 +226,13 @@ prometheus_fortigate_exporter:
restart: unless-stopped
```

## Known Issues

This is a collection of known issues that for some reason cannot be fixed,
but might be possible to work around.

* Probing causing [httpsd memory leak in FortiOS 6.2.x](https://github.com/bluecmd/fortigate_exporter/issues/62) ([Workaround](https://github.com/bluecmd/fortigate_exporter/issues/62#issuecomment-798602061))

## Missing Metrics?

Please [file an issue](https://github.com/bluecmd/fortigate_exporter/issues/new) describing what metrics you'd like to see.
Expand Down