@@ -9,16 +9,15 @@ The `usage_reporting` configuration object allows you to control over how the Hi
99
1010## Options
1111
12- ### ` token `
12+ ### ` access_token `
1313
1414- ** Type:** ` string `
1515
1616Your
1717[ Registry Access Token] ( https://the-guild.dev/graphql/hive/docs/management/targets#registry-access-tokens )
1818with write permission.
1919
20- Alternatively, you can set the ` HIVE__USAGE_REPORTING__TOKEN ` environment variable to provide the
21- token.
20+ Alternatively, you can set the ` HIVE_ACCESS_TOKEN ` environment variable to provide the token.
2221
2322### ` target_id `
2423
@@ -29,8 +28,7 @@ A target ID, this can either be a slug following the format
2928` a0f4c605-6541-4350-8cfe-b31f21a4bf80 ` ). To be used when the token is configured with an
3029organization access token.
3130
32- Alternatively, you can set the ` HIVE__USAGE_REPORTING__TARGET_ID ` environment variable to provide
33- the target ID.
31+ Alternatively, you can set the ` HIVE_TARGET ` environment variable to provide the target ID.
3432
3533### ` endpoint `
3634
@@ -41,12 +39,12 @@ For self-hosting, you can override `/usage` endpoint of your Hive instance.
4139
4240### ` sample_rate `
4341
44- - ** Type:** ` number `
45- - ** Default:** ` 1.0 `
42+ - ** Type:** ` string `
43+ - ** Default:** ` 100% `
4644
47- A value between ` 0.0 ` and ` 1.0 ` that indicates the percentage of requests to be reported. For
48- example, a value of ` 0.1 ` means that approximately 10% of requests will be reported, while a value
49- of ` 1.0 ` means that all requests will be reported.
45+ A percentage value between ` 0% ` and ` 100% ` that indicates the percentage of requests to be reported.
46+ For example, a value of ` 10% ` means that approximately 10% of requests will be reported, while a
47+ value of ` 100% ` means that all requests will be reported.
5048
5149### ` exclude `
5250
@@ -90,21 +88,23 @@ This can be useful for self-hosted Hive instances using self-signed certificates
9088
9189### ` connect_timeout `
9290
93- - ** Type:** ` integer `
94- - ** Default:** ` 5 `
91+ - ** Type:** ` string `
92+ - ** Default:** ` 5s `
9593
96- A timeout for only the connect phase of a request to Hive Console, in seconds.
94+ A timeout for only the connect phase of a request to Hive Console, in duration format (e.g., ` 5s `
95+ for 5 seconds).
9796
9897### ` request_timeout `
9998
100- - ** Type:** ` integer `
101- - ** Default:** ` 15 `
99+ - ** Type:** ` string `
100+ - ** Default:** ` 15s `
102101
103- A timeout for the entire request to Hive Console, in seconds.
102+ A timeout for the entire request to Hive Console, in duration format (e.g., ` 15s ` for 15 seconds) .
104103
105104### ` flush_interval `
106105
107- - ** Type:** ` integer `
108- - ** Default:** ` 5 `
106+ - ** Type:** ` string `
107+ - ** Default:** ` 5s `
109108
110- The interval in seconds at which the usage report buffer is flushed and sent to Hive Console.
109+ The interval in seconds at which the usage report buffer is flushed and sent to Hive Console. In
110+ duration format (e.g., ` 5s ` for 5 seconds).
0 commit comments