Skip to content

Commit

Permalink
[automated commit] Bump docs to version 1.32.0
Browse files Browse the repository at this point in the history
  • Loading branch information
leorossi authored and github-actions[bot] committed Apr 4, 2024
1 parent d2e3779 commit d94bbf4
Show file tree
Hide file tree
Showing 159 changed files with 21 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The client configuration in the `platformatic.db.json` and `platformatic.service
}
```

Note that the generator would also have updated the `.env` and `.env.sample` files if they exists.
Note that the generator would also have updated the `.env` and `.env.sample` files if they exist.

## Generating a client for a service running within Platformatic Runtime

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Configuration settings are organized into the following groups:
- [`telemetry`](#telemetry)
- [`server`](#server)
- [`undici`](#undici)
- [`metrics`](#metrics)
- [`managementApi`](#managementapi(experimantal)) **(experimental)**

Configuration settings containing sensitive data should be set using
Expand Down Expand Up @@ -196,24 +197,28 @@ Allowing to configure the options in the agent as well as [interceptors](https:/
Note that IDP stands for Identity Provider, and its token url is the URL that will be called to generate a new
token.

### `metrics`

This configures the Platformatic Runtime Prometheus server. The Prometheus server exposes aggregated metrics from the Platformatic Runtime services.

- **`hostname`** (`string`). The hostname where the Prometheus server will be listening. Default: `0.0.0.0`.
- **`port`** (`number`). The port where the Prometheus server will be listening. Default: `9090`.
- **`endpoint`** (`string`). The endpoint where the Prometheus server will be listening. Default: `/metrics`.
- **`auth`** (`object`). Optional configuration for the Prometheus server authentication.
- **`username`** (`string`). The username for the Prometheus server authentication.
- **`password`** (`string`). The password for the Prometheus server authentication.

### `managementApi`

> **Warning:** Experimental. The feature is not subject to semantic versioning rules. Non-backward compatible changes or removal may occur in any future release. Use of the feature is not recommended in production environments.
An optional object that configures the Platformatic Management Api. If this object
is not provided, the Platformatic Management Api will not be started. The options are
passed directly to the Fastify server that backs the Management API. If enabled, it will listen to UNIX Socket/Windows named pipe located at `platformatic/pids/<PID>` inside the OS temporary folder.

_Example_
is not provided, the Platformatic Management Api will not be started. If enabled,
it will listen to UNIX Socket/Windows named pipe located at `platformatic/pids/<PID>`
inside the OS temporary folder.

```json
{
"managementApi": {
"logger": true,
"trustProxy": true
}
}
```
- **`logs`** (`object`). Optional configuration for the runtime logs.
- **`maxSize`** (`number`). Maximum size of the logs that will be stored in the file system in MB. Default: `200`. Minimum: `5`.

## Environment variable placeholders

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ This setting can be a `boolean` or an `object`. If set to `true` the Prometheus

Supported object properties:

- **`server`** (`enum`) — Can be set to "own" or "parent", determines if metrics will be served on a different server or the same server as the Platformatic application.
- **`server`** (`enum`) — Can be set to "own", "parent" or "hide" determines if metrics will be served on a different server or the same server as the Platformatic application or hidden at all.
- **`hostname`** (`string`) — The hostname where Prometheus server will listen for connections, should be used only if `server` is set to "own".
- **`port`** (`number` or `string`) — The port where Prometheus server will listen for connections, should be used only if `server` is set to "own".
- **`endpoint`** (`string`) — The endpoint on which metrics will be served.
Expand Down
4 changes: 2 additions & 2 deletions versions.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[
"1.32.0",
"1.31.1",
"1.31.0",
"1.30.0",
"1.29.0",
"1.28.1"
"1.29.0"
]

0 comments on commit d94bbf4

Please sign in to comment.