Skip to content

Commit 0da98d1

Browse files
committed
add the info about the new params to docs
Signed-off-by: Afzal Ansari <[email protected]>
1 parent 71bff33 commit 0da98d1

File tree

8 files changed

+35
-6
lines changed

8 files changed

+35
-6
lines changed

docs/services/alertmanager.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ The notification service is used to push events to [Alertmanager](https://github
1111
* `basicAuth` - optional, server auth
1212
* `bearerToken` - optional, server auth
1313
* `timeout` - optional, the timeout in seconds used when sending alerts, default is "3 seconds"
14+
* `maxIdleConns` - optional, maximum number of idle (keep-alive) connections across all hosts.
15+
* `maxIdleConnsPerHost` - optional, maximum number of idle (keep-alive) connections per host.
16+
* `maxConnsPerHost` - optional, maximum total connections per host.
17+
* `idleConnTimeout` - optional, maximum amount of time an idle (keep-alive) connection will remain open before closing.
1418

1519
`basicAuth` or `bearerToken` is used for authentication, you can choose one. If the two are set at the same time, `basicAuth` takes precedence over `bearerToken`.
1620

docs/services/github.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@ The GitHub notification service changes commit status using [GitHub Apps](https:
88
- `installationID` - the app installation id
99
- `privateKey` - the app private key
1010
- `enterpriseBaseURL` - optional URL, e.g. https://git.example.com/api/v3
11+
- `maxIdleConns` - optional, maximum number of idle (keep-alive) connections across all hosts.
12+
- `maxIdleConnsPerHost` - optional, maximum number of idle (keep-alive) connections per host.
13+
- `maxConnsPerHost` - optional, maximum total connections per host.
14+
- `idleConnTimeout` - optional, maximum amount of time an idle (keep-alive) connection will remain open before closing.
1115

1216
> ⚠️ _NOTE:_ Specifying `/api/v3` in the `enterpriseBaseURL` is required until [argoproj/notifications-engine#205](https://github.com/argoproj/notifications-engine/issues/205) is resolved.
1317

docs/services/grafana.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ Available parameters :
99
* `apiURL` - the server url, e.g. https://grafana.example.com
1010
* `apiKey` - the API key for the serviceaccount
1111
* `insecureSkipVerify` - optional bool, true or false
12+
* `maxIdleConns` - optional, maximum number of idle (keep-alive) connections across all hosts.
13+
* `maxIdleConnsPerHost` - optional, maximum number of idle (keep-alive) connections per host.
14+
* `maxConnsPerHost` - optional, maximum total connections per host.
15+
* `idleConnTimeout` - optional, maximum amount of time an idle (keep-alive) connection will remain open before closing.
1216

1317
1. Login to your Grafana instance as `admin`
1418
2. On the left menu, go to Configuration / API Keys

docs/services/mattermost.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
* `apiURL` - the server url, e.g. https://mattermost.example.com
66
* `token` - the bot token
77
* `insecureSkipVerify` - optional bool, true or false
8+
* `maxIdleConns` - optional, maximum number of idle (keep-alive) connections across all hosts.
9+
* `maxIdleConnsPerHost` - optional, maximum number of idle (keep-alive) connections per host.
10+
* `maxConnsPerHost` - optional, maximum total connections per host.
11+
* `idleConnTimeout` - optional, maximum amount of time an idle (keep-alive) connection will remain open before closing, e.g. '90s'.
812

913
## Configuration
1014

docs/services/newrelic.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44

55
* `apiURL` - the api server url, e.g. https://api.newrelic.com
66
* `apiKey` - a [NewRelic ApiKey](https://docs.newrelic.com/docs/apis/rest-api-v2/get-started/introduction-new-relic-rest-api-v2/#api_key)
7+
* `maxIdleConns` - optional, maximum number of idle (keep-alive) connections across all hosts.
8+
* `maxIdleConnsPerHost` - optional, maximum number of idle (keep-alive) connections per host.
9+
* `maxConnsPerHost` - optional, maximum total connections per host.
10+
* `idleConnTimeout` - optional, maximum amount of time an idle (keep-alive) connection will remain open before closing, e.g. '90s'.
711

812
## Configuration
913

docs/services/slack.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,11 @@ The Slack notification service configuration includes following settings:
1616
| `token` | **True** | `string` | The app's OAuth access token. | `xoxb-1234567890-1234567890123-5n38u5ed63fgzqlvuyxvxcx6` |
1717
| `username` | False | `string` | The app username. | `argocd` |
1818
| `disableUnfurl` | False | `bool` | Disable slack unfurling links in messages | `true` |
19+
| `maxIdleConns` | False | `int` | Maximum number of idle (keep-alive) connections across all hosts. ||
20+
| `maxIdleConnsPerHost` | False | `int` | Maximum number of idle (keep-alive) connections per host. ||
21+
| `maxConnsPerHost` | False | `int` | Maximum total connections per host. ||
22+
| `idleConnTimeout` | False | `string` | Maximum amount of time an idle (keep-alive) connection will remain open before closing (e.g., `90s`). ||
23+
1924

2025
## Configuration
2126

docs/services/webhook.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ The Webhook notification service configuration includes following settings:
1414
- `retryWaitMin` - Optional, the minimum wait time between retries. Default value: 1s.
1515
- `retryWaitMax` - Optional, the maximum wait time between retries. Default value: 5s.
1616
- `retryMax` - Optional, the maximum number of retries. Default value: 3.
17+
- `maxIdleConns` - optional, maximum number of idle (keep-alive) connections across all hosts.
18+
- `maxIdleConnsPerHost` - optional, maximum number of idle (keep-alive) connections per host.
19+
- `maxConnsPerHost` - optional, maximum total connections per host.
20+
- `idleConnTimeout` - optional, maximum amount of time an idle (keep-alive) connection will remain open before closing, e.g. '90s'.
1721

1822
## Retry Behavior
1923

pkg/services/newrelic.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ import (
1616
)
1717

1818
type NewrelicOptions struct {
19-
ApiKey string `json:"apiKey"`
20-
ApiURL string `json:"apiURL"`
21-
InsecureSkipVerify bool `json:"insecureSkipVerify"`
22-
MaxIdleConns int `json:"maxIdleConns"`
23-
MaxIdleConnsPerHost int `json:"maxIdleConnsPerHost"`
24-
MaxConnsPerHost int `json:"maxConnsPerHost"`
19+
ApiKey string `json:"apiKey"`
20+
ApiURL string `json:"apiURL"`
21+
InsecureSkipVerify bool `json:"insecureSkipVerify"`
22+
MaxIdleConns int `json:"maxIdleConns"`
23+
MaxIdleConnsPerHost int `json:"maxIdleConnsPerHost"`
24+
MaxConnsPerHost int `json:"maxConnsPerHost"`
2525
IdleConnTimeout string `json:"idleConnTimeout"`
2626
}
2727

0 commit comments

Comments
 (0)