Skip to content

Commit

Permalink
deploy: 748d308
Browse files Browse the repository at this point in the history
  • Loading branch information
@tboerger
tboerger committed Oct 26, 2023
1 parent 955a68f commit 6f503b2
Showing 1 changed file with 45 additions and 20 deletions.
65 changes: 45 additions & 20 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@
line-height: 1.6;
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
color: #242424;
max-width: 800px;
max-width: 900px;
margin: 5% auto;
}

Expand Down Expand Up @@ -130,6 +130,7 @@
h3 {
font-size: 18px;
margin-bottom: 0.3em;
margin-top: 1.0em;
}

h1 small a {
Expand Down Expand Up @@ -230,6 +231,11 @@

dl dt {
font-weight: bold;
margin-top: 10px;
}

dl dt:first-child {
margin-top: 0px;
}

dl dd {
Expand Down Expand Up @@ -487,6 +493,19 @@ <h2 id="installation">Installation</h2>
</span></span><span class="line"><span class="cl"> - HETZNER_EXPORTER_PASSWORD=CNFPCgivAAqWu613
</span></span><span class="line"><span class="cl"> - HETZNER_EXPORTER_LOG_PRETTY=true
</span></span></code></pre></div>
<p>If you want to provide the required secrets from a file it&rsquo;s also possible. For
this use case you can write the secret to a file on any path and reference it
with the following format:</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-diff" data-lang="diff"><span class="line"><span class="cl"> hetzner_exporter:
</span></span><span class="line"><span class="cl"> image: promhippie/hetzner-exporter:latest
</span></span><span class="line"><span class="cl"> restart: always
</span></span><span class="line"><span class="cl"> environment:
</span></span><span class="line"><span class="cl"><span class="gd">- - HETZNER_EXPORTER_USERNAME=#ws+qOeMD4UP
</span></span></span><span class="line"><span class="cl"><span class="gd">- - HETZNER_EXPORTER_PASSWORD=CNFPCgivAAqWu613
</span></span></span><span class="line"><span class="cl"><span class="gd"></span><span class="gi">+ - HETZNER_EXPORTER_USERNAME=file://path/to/secret/file/with/username
</span></span></span><span class="line"><span class="cl"><span class="gi">+ - HETZNER_EXPORTER_PASSWORD=file://path/to/secret/file/with/password
</span></span></span><span class="line"><span class="cl"><span class="gi"></span> - HETZNER_EXPORTER_LOG_PRETTY=true
</span></span></code></pre></div>
<p>Finally the exporter should be configured fine, let&rsquo;s start this stack with
<a href="https://docs.docker.com/compose/">docker-compose</a>, you just need to execute <code>docker-compose up</code> within
the directory where you have stored the <code>prometheus.yml</code> and
Expand All @@ -506,6 +525,12 @@ <h2 id="configuration">Configuration</h2>
<dd>Address to bind the metrics server, defaults to <code>0.0.0.0:9502</code></dd>
<dt>HETZNER_EXPORTER_WEB_PATH</dt>
<dd>Path to bind the metrics server, defaults to <code>/metrics</code></dd>
<dt>HETZNER_EXPORTER_WEB_PPROF</dt>
<dd>Enable pprof debugging for server, defaults to <code>false</code></dd>
<dt>HETZNER_EXPORTER_WEB_TIMEOUT</dt>
<dd>Server metrics endpoint timeout, defaults to <code>10s</code></dd>
<dt>HETZNER_EXPORTER_WEB_CONFIG</dt>
<dd>Path to web-config file</dd>
<dt>HETZNER_EXPORTER_REQUEST_TIMEOUT</dt>
<dd>Request timeout as duration, defaults to <code>5s</code></dd>
<dt>HETZNER_EXPORTER_USERNAME</dt>
Expand Down Expand Up @@ -535,41 +560,41 @@ <h2 id="metrics">Metrics</h2>
<dd>Histogram of latencies for requests to the api per collector</dd>
<dt>hetzner_request_failures_total{collector}</dt>
<dd>Total number of failed requests to the api per collector</dd>
<dt>hetzner_server_cancelled{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_server_cancelled{id, name, datacenter}</dt>
<dd>If 1 the server have been cancelled, 0 otherwise</dd>
<dt>hetzner_server_flatrate{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_server_flatrate{id, name, datacenter}</dt>
<dd>If 1 the server got a flatrate enabled, 0 otherwise</dd>
<dt>hetzner_server_paid_timestamp{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_server_paid_timestamp{id, name, datacenter}</dt>
<dd>Timestamp of the date until server is paid</dd>
<dt>hetzner_server_running{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_server_running{id, name, datacenter}</dt>
<dd>If 1 the server is running, 0 otherwise</dd>
<dt>hetzner_server_traffic_bytes{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_server_traffic_bytes{id, name, datacenter}</dt>
<dd>Amount of included traffic for the server</dd>
<dt>hetzner_ssh_key{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_ssh_key{name, type, size, fingerprint}</dt>
<dd>Information about SSH keys in your Hetzner robot</dd>
<dt>hetzner_storagebox_cancelled{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_cancelled{id, name, location, login}</dt>
<dd>If 1 the storagebox have been cancelled, 0 otherwise</dd>
<dt>hetzner_storagebox_data{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_data{id, name, location, login}</dt>
<dd>Used storage by files for the storagebox in MB</dd>
<dt>hetzner_storagebox_external{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_external{id, name, location, login}</dt>
<dd>If 1 the storagebox can be accessed from external, 0 otherwise</dd>
<dt>hetzner_storagebox_locked{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_locked{id, name, location, login}</dt>
<dd>If 1 the storagebox have been locked, 0 otherwise</dd>
<dt>hetzner_storagebox_paid{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_paid{id, name, location, login}</dt>
<dd>Timestamp of the date until storagebox is paid</dd>
<dt>hetzner_storagebox_quota{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_quota{id, name, location, login}</dt>
<dd>Available storage for the storagebox in MB</dd>
<dt>hetzner_storagebox_samba{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_samba{id, name, location, login}</dt>
<dd>If 1 the storagebox can be accessed via samba, 0 otherwise</dd>
<dt>hetzner_storagebox_snapshots{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_snapshots{id, name, location, login}</dt>
<dd>Used storage by snapshots for the storagebox in MB</dd>
<dt>hetzner_storagebox_ssh{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_ssh{id, name, location, login}</dt>
<dd>If 1 the storagebox can be accessed via ssh, 0 otherwise</dd>
<dt>hetzner_storagebox_usage{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_usage{id, name, location, login}</dt>
<dd>Used storage for the storagebox in MB</dd>
<dt>hetzner_storagebox_webdav{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_webdav{id, name, location, login}</dt>
<dd>If 1 the storagebox can be accessed via webdav, 0 otherwise</dd>
<dt>hetzner_storagebox_zfs{&lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;, &lt;prometheus.ConstrainedLabel Value&gt;}</dt>
<dt>hetzner_storagebox_zfs{id, name, location, login}</dt>
<dd>If 1 the zfs directory is visible, 0 otherwise</dd>
</dl>

Expand Down Expand Up @@ -631,7 +656,7 @@ <h3 id="helm">Helm</h3>
</span></span></span><span class="line"><span class="cl"><span class="go">helm install hetzner-exporter promhippie/hetzner-exporter
</span></span></span></code></pre></div>
<p>You can also watch that available values and generally the details of the chart
provided by us within our <a href="https://github.com/promhippie/charts/tree/master/charts/hetzner-exporter">chart</a> repository.</p>
provided by us within our <a href="https://github.com/promhippie/charts/tree/master/stable/hetzner-exporter">chart</a> repository or on <a href="https://artifacthub.io/packages/helm/promhippie/hetzner-exporter">Artifacthub</a>.</p>
<p>After applying this manifest the exporter should be directly visible within your
Prometheus instance depending on your installation if you enabled the
annotations or the service monitor.</p>
Expand Down

0 comments on commit 6f503b2

Please sign in to comment.