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

Fixed tab formatting #248

Merged
merged 2 commits into from
Dec 12, 2023
Merged

Fixed tab formatting #248

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
55c9931
fix tab formatting
MadelineMurray Dec 11, 2023
b4de6e7
Merge remote-tracking branch 'origin/main' into fixFormatting
MadelineMurray Dec 12, 2023
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
81 changes: 50 additions & 31 deletions docs/reference/cli/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,67 +598,75 @@ We don't recommend allowing all hostnames for production environments.

### `metrics-push-enabled`

<!--tabs-->
<Tabs>

# Syntax
<TabItem value="Syntax" label="Syntax" default>

```bash
--metrics-push-enabled[=<true|false>]
```

# Example
</TabItem>
<TabItem value="Example" label="Example" >

```bash
--metrics-push-enabled=true
```

# Environment variable
</TabItem>
<TabItem value="Environment variable" label="Environment variable" >

```bash
WEB3SIGNER_METRICS_PUSH_ENABLED=true
```

# Configuration file
</TabItem>
<TabItem value="Configuration file" label="Configuration file" >

```bash
metrics-push-enabled=true
```

<!--/tabs-->
</TabItem>
</Tabs>

Enables or disables [push gateway integration](../../how-to/monitor/metrics.md#run-prometheus-with-web3signer-in-push-mode).

You can't specify `--metrics-push-enabled` with [`--metrics-enabled`](#metrics-enabled). That is, you can enable either Prometheus polling or Prometheus push gateway support, but not both at once.

### `metrics-push-host`

<!--tabs-->
<Tabs>

# Syntax
<TabItem value="Syntax" label="Syntax" default>

```bash
--metrics-push-host=<HOST>
```

# Example
</TabItem>
<TabItem value="Example" label="Example" >

```bash
--metrics-push-host=127.0.0.1
```

# Environment variable
</TabItem>
<TabItem value="Environment variable" label="Environment variable" >

```bash
WEB3SIGNER_METRICS_PUSH_HOST=127.0.0.1
```

# Configuration file
</TabItem>
<TabItem value="Configuration file" label="Configuration file" >

```bash
metrics-push-host="127.0.0.1"
```

<!--/tabs-->
</TabItem>
</Tabs>

The host of the [Prometheus Push Gateway](https://github.com/prometheus/pushgateway). The default is `127.0.0.1`. The metrics server respects the [`--metrics-host-allowlist` option](#metrics-host-allowlist).

Expand All @@ -670,101 +678,112 @@ When pushing metrics, ensure you set `--metrics-push-host` to the machine on whi

### `metrics-push-interval`

<!--tabs-->
<Tabs>

# Syntax
<TabItem value="Syntax" label="Syntax" default>

```bash
--metrics-push-interval=<INTEGER>
```

# Example
</TabItem>
<TabItem value="Example" label="Example" >

```bash
--metrics-push-interval=30
```

# Environment variable
</TabItem>
<TabItem value="Environment variable" label="Environment variable" >

```bash
WEB3SIGNER_METRICS_PUSH_INTERVAL=30
```

# Configuration file
</TabItem>
<TabItem value="Configuration file" label="Configuration file" >

```bash
metrics-push-interval=30
```

<!--/tabs-->
</TabItem>
</Tabs>

The interval, in seconds, to push metrics when in `push` mode. The default is 15.

### `metrics-push-port`

<!--tabs-->
<Tabs>

# Syntax
<TabItem value="Syntax" label="Syntax" default>

```bash
--metrics-push-port=<PORT>
```

# Example
</TabItem>
<TabItem value="Example" label="Example" >

```bash
--metrics-push-port=6174
```

# Environment variable
</TabItem>
<TabItem value="Environment variable" label="Environment variable" >

```bash
WEB3SIGNER_METRICS_PUSH_PORT=6174
```

# Configuration file
</TabItem>
<TabItem value="Configuration file" label="Configuration file" >

```bash
metrics-push-port="6174"
```

<!--/tabs-->
</TabItem>
</Tabs>

The port (TCP) of the [Prometheus Push Gateway](https://github.com/prometheus/pushgateway). The default is `9001`.

### `metrics-push-prometheus-job`

<!--tabs-->
<Tabs>

# Syntax
<TabItem value="Syntax" label="Syntax" default>

```bash
--metrics-push-prometheus-job=<metricsPrometheusJob>
```

# Example
</TabItem>
<TabItem value="Example" label="Example" >

```bash
--metrics-push-prometheus-job="my-custom-job"
```

# Environment variable
</TabItem>
<TabItem value="Environment variable" label="Environment variable" >

```bash
WEB3SIGNER_METRICS_PUSH_PROMETHEUS_JOB="my-custom-job"
```

# Configuration file
</TabItem>
<TabItem value="Configuration file" label="Configuration file" >

```bash
metrics-push-prometheus-job="my-custom-job"
```

<!--/tabs-->
</TabItem>
</Tabs>

The job name when in `push` mode. The default is `web3signer-job`.


### `swagger-ui-enabled`

<Tabs>
Expand Down
Loading