Skip to content

Commit

Permalink
Merge pull request #3 from wexder/feature/custom-app-doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Supporterino authored Dec 29, 2023
2 parents f774d31 + b427636 commit 33893c6
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
<ul>
<li><a href="#truenas-scale">TrueNAS Scale</a></li>
<li><a href="#graphite_exporter">graphite_exporter</a></li>
<li><a href="#running-exporter-inside-truenas">Running exporter inside truenas</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
Expand Down Expand Up @@ -83,6 +84,20 @@ The destination ip and port need to be set to target your `graphite_exporter` I

You obviously need a running `graphite_exporter` which is scrabed by your prometheus instance and is reachable by your TrueNAS instance to push metrics to.

### Running exporter inside truenas

There's no official helm char we can run graphite_exporter with, but we can create our own quite easilly.
Inside of TrueNAS you have to open the `Apps` tab and then click `Discover Apps` and then `Custom App` to create custom app instead of installing app.
You can name the application how ever you want, use the default version.
The image to use is `ghcr.io/supporterino/truenas-graphite-to-prometheus` and image tag `latest`. For image policy can be left untouched.
![Image setting](./images/custom_app_container_image.png)
The only other setting you have to change is the port forwarding. Here we have to forward two ports, one for graphite and one for prometheus.
For graphite container port is `9109`, for node port you can choose the same port or specify what ever open port you have. Protocol is `TCP`.
The same for prometheus with container port `9108` and also `TCP` protocol
For example like this.
![Port forwarding](./images/custom_app_port_forward.png)
You can set resource limits, but the exporter is super light weight so it's not necessary.

<!-- USAGE EXAMPLES -->
## Usage

Expand Down
Binary file added images/custom_app_container_image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/custom_app_port_forward.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 33893c6

Please sign in to comment.