Go

Author: ardatan

docs/README.md

@@ -16,7 +16,7 @@
 |[**query\_planner**](#query_planner)|`object`|Query planning configuration.<br/>Default: `{"allow_expose":false,"timeout":"10s"}`<br/>||
 |[**supergraph**](#supergraph)|`object`|Configuration for the Federation supergraph source. By default, the router will use a local file-based supergraph source (`./supergraph.graphql`).<br/>||
 |[**traffic\_shaping**](#traffic_shaping)|`object`|Configuration for the traffic-shaper executor. Use these configurations to control how requests are being executed to subgraphs.<br/>Default: `{"dedupe_enabled":true,"max_connections_per_host":100,"pool_idle_timeout_seconds":50}`<br/>||
-|[**usage\_reporting**](#usage_reporting)|`object`, `null`|Configuration for usage reporting to GraphQL Hive.<br/>|yes|
+|[**usage\_reporting**](#usage_reporting)|`object`|Configuration for usage reporting to GraphQL Hive.<br/>Default: `{"accept_invalid_certs":false,"access_token":"","buffer_size":1000,"client_name_header":"graphql-client-name","client_version_header":"graphql-client-version","connect_timeout":"5s","enabled":false,"endpoint":"https://app.graphql-hive.com/usage","exclude":[],"flush_interval":"5s","request_timeout":"15s","sample_rate":"100%","target_id":null}`<br/>|yes|
 
 **Additional Properties:** not allowed  
 **Example**
@@ -111,7 +111,20 @@ traffic_shaping:
   dedupe_enabled: true
   max_connections_per_host: 100
   pool_idle_timeout_seconds: 50
-usage_reporting: null
+usage_reporting:
+  accept_invalid_certs: false
+  access_token: ''
+  buffer_size: 1000
+  client_name_header: graphql-client-name
+  client_version_header: graphql-client-version
+  connect_timeout: 5s
+  enabled: false
+  endpoint: https://app.graphql-hive.com/usage
+  exclude: []
+  flush_interval: 5s
+  request_timeout: 15s
+  sample_rate: 100%
+  target_id: null
 
 ```
 
@@ -1832,7 +1845,7 @@ pool_idle_timeout_seconds: 50
 ```
 
 <a name="usage_reporting"></a>
-## usage\_reporting: object,null
+## usage\_reporting: object
 
 Configuration for usage reporting to GraphQL Hive.
 
@@ -1847,18 +1860,31 @@ Configuration for usage reporting to GraphQL Hive.
 |**client\_name\_header**|`string`|Default: `"graphql-client-name"`<br/>|no|
 |**client\_version\_header**|`string`|Default: `"graphql-client-version"`<br/>|no|
 |**connect\_timeout**|`string`|A timeout for only the connect phase of a request to Hive Console<br/>Default: 5 seconds<br/>Default: `"5s"`<br/>|no|
+|**enabled**|`boolean`|Default: `false`<br/>|no|
 |**endpoint**|`string`|For self-hosting, you can override `/usage` endpoint (defaults to `https://app.graphql-hive.com/usage`).<br/>Default: `"https://app.graphql-hive.com/usage"`<br/>|no|
 |[**exclude**](#usage_reportingexclude)|`string[]`|A list of operations (by name) to be ignored by Hive.<br/>Default: <br/>|no|
 |**flush\_interval**|`string`|Frequency of flushing the buffer to the server<br/>Default: 5 seconds<br/>Default: `"5s"`<br/>|no|
 |**request\_timeout**|`string`|A timeout for the entire request to Hive Console<br/>Default: 15 seconds<br/>Default: `"15s"`<br/>|no|
-|**sample\_rate**|`number`|Sample rate to determine sampling.<br/>0.0 = 0% chance of being sent<br/>1.0 = 100% chance of being sent<br/>Default: 1.0<br/>Default: `1`<br/>Format: `"double"`<br/>|no|
+|**sample\_rate**|`string`|Sample rate to determine sampling.<br/>0% = never being sent<br/>50% = half of the requests being sent<br/>100% = always being sent<br/>Default: 100%<br/>Default: `"100%"`<br/>|no|
 |**target\_id**|`string`, `null`|A target ID, this can either be a slug following the format “$organizationSlug/$projectSlug/$targetSlug” (e.g “the-guild/graphql-hive/staging”) or an UUID (e.g. “a0f4c605-6541-4350-8cfe-b31f21a4bf80”). To be used when the token is configured with an organization access token.<br/>|no|
 
 **Additional Properties:** not allowed  
 **Example**
 
 ```yaml
-{}
+accept_invalid_certs: false
+access_token: ''
+buffer_size: 1000
+client_name_header: graphql-client-name
+client_version_header: graphql-client-version
+connect_timeout: 5s
+enabled: false
+endpoint: https://app.graphql-hive.com/usage
+exclude: []
+flush_interval: 5s
+request_timeout: 15s
+sample_rate: 100%
+target_id: null
 
 ```
 

lib/router-config/src/usage_reporting.rs

@@ -8,14 +8,17 @@ use serde::{Deserialize, Serialize};
 pub struct UsageReportingConfig {
     #[serde(default = "default_enabled")]
     pub enabled: bool,
+
     /// Your [Registry Access Token](https://the-guild.dev/graphql/hive/docs/management/targets#registry-access-tokens) with write permission.
     pub access_token: String,
+
     /// A target ID, this can either be a slug following the format “$organizationSlug/$projectSlug/$targetSlug” (e.g “the-guild/graphql-hive/staging”) or an UUID (e.g. “a0f4c605-6541-4350-8cfe-b31f21a4bf80”). To be used when the token is configured with an organization access token.
     #[serde(deserialize_with = "deserialize_target_id")]
     pub target_id: Option<String>,
     /// For self-hosting, you can override `/usage` endpoint (defaults to `https://app.graphql-hive.com/usage`).
     #[serde(default = "default_endpoint")]
     pub endpoint: String,
+
     /// Sample rate to determine sampling.
     /// 0% = never being sent
     /// 50% = half of the requests being sent
@@ -24,22 +27,27 @@ pub struct UsageReportingConfig {
     #[serde(default = "default_sample_rate")]
     #[schemars(with = "String")]
     pub sample_rate: Percentage,
+
     /// A list of operations (by name) to be ignored by Hive.
     /// Example: ["IntrospectionQuery", "MeQuery"]
     #[serde(default)]
     pub exclude: Vec<String>,
+
     #[serde(default = "default_client_name_header")]
     pub client_name_header: String,
     #[serde(default = "default_client_version_header")]
     pub client_version_header: String,
+
     /// A maximum number of operations to hold in a buffer before sending to Hive Console
     /// Default: 1000
     #[serde(default = "default_buffer_size")]
     pub buffer_size: usize,
+
     /// Accepts invalid SSL certificates
     /// Default: false
     #[serde(default = "default_accept_invalid_certs")]
     pub accept_invalid_certs: bool,
+
     /// A timeout for only the connect phase of a request to Hive Console
     /// Default: 5 seconds
     #[serde(
@@ -49,6 +57,7 @@ pub struct UsageReportingConfig {
     )]
     #[schemars(with = "String")]
     pub connect_timeout: Duration,
+
     /// A timeout for the entire request to Hive Console
     /// Default: 15 seconds
     #[serde(
@@ -58,6 +67,7 @@ pub struct UsageReportingConfig {
     )]
     #[schemars(with = "String")]
     pub request_timeout: Duration,
+
     /// Frequency of flushing the buffer to the server
     /// Default: 5 seconds
     #[serde(