Skip to content

Commit a392381

Browse files
mostafamostafa
committed
Update docs
1 parent 54aed8c commit a392381

File tree

6 files changed

+28
-14
lines changed

6 files changed

+28
-14
lines changed

‎getting-started/running-gatewayd.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -95,20 +95,20 @@ Running GatewayD will produce the following log output, which means that Gateway
9595
5. exposing an HTTP and a gRPC API on ports `18080` and `19090`.
9696

9797
```bash
98-
2023-04-08T02:01:04+02:00 INF configuring client automatic mTLS plugin=gatewayd-plugin-cache
99-
2023-04-08T02:01:04+02:00 INF Starting metrics server via HTTP over Unix domain socket endpoint=/metrics plugin=gatewayd-plugin-cache timestamp=2023-04-08T02:01:04.242+0200 unixDomainSocket=/tmp/gatewayd-plugin-cache.sock
100-
2023-04-08T02:01:04+02:00 INF configuring server automatic mTLS plugin=gatewayd-plugin-cache timestamp=2023-04-08T02:01:04.243+0200
101-
2023-04-08T02:01:04+02:00 INF Registering plugin hooks name=gatewayd-plugin-cache
102-
2023-04-08T02:01:04+02:00 INF Plugin is ready name=gatewayd-plugin-cache
103-
2023-04-08T02:01:04+02:00 INF Started the metrics merger scheduler metricsMergerPeriod=5s startDelay=1680912069
104-
2023-04-08T02:01:04+02:00 INF Starting plugin health check scheduler healthCheckPeriod=5s
105-
2023-04-08T02:01:04+02:00 INF Metrics are exposed address=http://localhost:9090/metrics
106-
2023-04-08T02:01:04+02:00 INF There are clients available in the pool count=10 name=default
107-
2023-04-08T02:01:04+02:00 INF Started the client health check scheduler healthCheckPeriod=1m0s startDelay=2023-04-08T02:02:04+02:00
108-
2023-04-08T02:01:04+02:00 INF GatewayD is listening address=0.0.0.0:15432
109-
2023-04-08T02:01:04+02:00 INF Started the HTTP API address=localhost:18080
110-
2023-04-08T02:01:04+02:00 INF Started the gRPC API address=localhost:19090 network=tcp
111-
2023-04-08T02:01:04+02:00 INF GatewayD is running pid=41568
98+
2023-11-15T22:50:29+01:00 INF configuring client automatic mTLS plugin=gatewayd-plugin-cache
99+
2023-11-15T22:50:29+01:00 INF Starting metrics server via HTTP over Unix domain socket endpoint=/metrics plugin=gatewayd-plugin-cache timestamp=2023-11-15T22:50:29.589+0100 unixDomainSocket=/tmp/gatewayd-plugin-cache.sock
100+
2023-11-15T22:50:29+01:00 INF configuring server automatic mTLS plugin=gatewayd-plugin-cache timestamp=2023-11-15T22:50:29.596+0100
101+
2023-11-15T22:50:29+01:00 INF Registering plugin hooks name=gatewayd-plugin-cache
102+
2023-11-15T22:50:29+01:00 INF Plugin is ready name=gatewayd-plugin-cache
103+
2023-11-15T22:50:29+01:00 INF Started the metrics merger scheduler metricsMergerPeriod=5s startDelay=2023-11-15T22:50:34+01:00
104+
2023-11-15T22:50:29+01:00 INF Starting plugin health check scheduler healthCheckPeriod=5s
105+
2023-11-15T22:50:29+01:00 INF Metrics are exposed address=http://localhost:9090/metrics readHeaderTimeout=10s timeout=10s
106+
2023-11-15T22:50:29+01:00 INF There are clients available in the pool count=10 name=default
107+
2023-11-15T22:50:29+01:00 INF Started the client health check scheduler healthCheckPeriod=1m0s startDelay=2023-11-15T22:51:29+01:00
108+
2023-11-15T22:50:29+01:00 INF GatewayD is listening address=0.0.0.0:15432
109+
2023-11-15T22:50:29+01:00 INF Started the HTTP API address=localhost:18080
110+
2023-11-15T22:50:29+01:00 INF Started the gRPC API address=localhost:19090 network=tcp
111+
2023-11-15T22:50:29+01:00 INF GatewayD is running pid=32371
112112
```
113113

114114
{: .note }

‎using-gatewayd/configuration.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ metricsMergerPeriod: 5s
130130
healthCheckPeriod: 5s
131131
reloadOnCrash: True
132132
timeout: 30s
133+
startTimeout: 1m
133134
plugins:
134135
- name: gatewayd-plugin-cache
135136
enabled: True

‎using-gatewayd/global-configuration/loggers.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ GatewayD supports multiple loggers, and each logger supports sending logs to mul
3838
| compress | boolean | True | True, False | Whether to compress rotated backup files or not |
3939
| localTime | boolean | False | True, False | Whether to use the local system time for formatting the timestamps in backup files. Default is UTC. |
4040

41+
{: .note }
42+
> If maxBackups and maxAge are both 0, no old log files will be deleted.
43+
4144
### Rsyslog
4245

4346
| Name | Type | Default value | Possible values | Description |

‎using-gatewayd/global-configuration/metrics.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ scrape_configs:
2929
| address | string | localhost:9090 | Valid host:port | The HTTP address and port to expose metrics on |
3030
| path | string | /metrics | Valid path values | The endpoint to expose metrics on |
3131
| readHeaderTimeout | duration (string) | 10s | Valid duration values | The maximum duration for reading the request headers. Setting this to a non-zero value will block Slowloris attacks. |
32+
| timeout | duration (string) | 10s | Valid duration values | The maximum duration before timing out. This applies to writes, reads, idle and handler timeouts separately. |
33+
| certFile | string | "" | Valid path values | The path to the TLS certificate file |
34+
| keyFile | string | "" | Valid path values | The path to the TLS key file |
3235
3336
## Built-in Metrics
3437
@@ -38,6 +41,7 @@ The following are built-in metrics emitted by GatewayD. The namespace of all the
3841
| ------------------------------------ | ------- | ------------------------------------------------------------------ |
3942
| client_connections | Gauge | Number of client connections |
4043
| server_connections | Gauge | Number of server connections |
44+
| tls_connections | Gauge | Number of TLS connections |
4145
| server_ticks_fired_total | Counter | Total number of server ticks fired |
4246
| bytes_received_from_client | Summary | Number of bytes received from client |
4347
| bytes_sent_to_server | Summary | Number of bytes sent to server |

‎using-gatewayd/plugins-configuration/general-configurations.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ grand_parent: Using GatewayD
2323
| healthCheckPeriod | string | 5s | Valid duration strings | The health check period controls how often the health check should be performed. The health check is performed by pinging each plugin. Unhealthy plugins are removed. |
2424
| reloadOnCrash | boolean | True | True, False | If enabled, GatewayD will reload the plugin if it crashes. The crash is detected by the health check. |
2525
| timeout | string | 30s | Valid duration strings | The timeout controls how long to wait for a plugin to respond to a request before timing out. |
26+
| startTimeout | string | 1m | Valid duration strings | The start timeout controls how long to wait for a plugin to start before timing out. |
2627

2728
## Example configuration
2829

@@ -36,4 +37,5 @@ metricsMergerPeriod: 5s
3637
healthCheckPeriod: 5s
3738
reloadOnCrash: True
3839
timeout: 30s
40+
startTimeout: 1m
3941
```

‎using-plugins/plugins.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ If a plugin crashes, GatewayD will reload it by the next health check if `reload
100100

101101
Plugin hooks have a timeout, which is configurable in the [general configuration](/using-gatewayd/plugins-configuration/general-configurations) of the plugins configuration file. If the plugin does not respond within the timeout, GatewayD will log the error and continue with the next plugin or continue processing if it is the last plugin.
102102

103+
## Start timeout
104+
105+
Plugins have a start timeout, which is configurable in the [general configuration](/using-gatewayd/plugins-configuration/general-configurations) of the plugins configuration file. If the plugin does not start within the timeout, GatewayD will log the error and continue with the next plugin or continue processing if it is the last plugin.
106+
103107
## Metrics merger
104108

105109
Plugins can choose to expose Prometheus metrics, either separately or together with GatewayD. If a plugin exposes metrics over [Unix Domain Socket](https://en.wikipedia.org/wiki/Unix_domain_socket), they are collected, relabeled and merged with metrics of GatewayD and exposed on the [`https://localhost:9090/metrics`](https://localhost:9090/metrics) endpoint. The metrics merger is configurable in the [general configuration](/using-gatewayd/plugins-configuration/general-configurations) of the plugins configuration file. If the metrics merger is disabled, the metrics won't be merged.

0 commit comments

Comments
 (0)