Update docs

Author: ardatan

bin/router/src/pipeline/mod.rs

@@ -150,7 +150,7 @@ pub async fn execute_pipeline(
     let operation_name = normalize_payload.operation_for_plan.name.as_ref();
 
     shared_state.usage_agent.as_ref().and_then(|usage_agent| {
-        shared_state.router_config.usage.as_ref().map(|usage_config| {
+        shared_state.router_config.usage_reporting.as_ref().map(|usage_config| {
             usage::send_usage_report(
                 supergraph.schema.clone(),
                 start,

bin/router/src/pipeline/usage.rs

@@ -3,7 +3,7 @@ use std::{sync::Arc, time::{Duration, Instant, SystemTime, UNIX_EPOCH}};
 use async_trait::async_trait;
 use graphql_parser::schema::Document;
 use hive_console_sdk::agent::{ExecutionReport, UsageAgent};
-use hive_router_config::{HiveRouterConfig, usage::UsageConfig};
+use hive_router_config::{HiveRouterConfig, usage_reporting::UsageReportingConfig};
 use hive_router_plan_executor::execution::plan::PlanExecutionOutput;
 use ntex::web::HttpRequest;
 use rand::Rng;
@@ -14,7 +14,7 @@ use crate::background_tasks::BackgroundTask;
 pub fn from_config(
     router_config: &HiveRouterConfig,
 ) -> Option<UsageAgent> {
-    router_config.usage.as_ref().map(|usage_config| {
+    router_config.usage_reporting.as_ref().map(|usage_config| {
         let flush_interval = Duration::from_secs(usage_config.flush_interval);
         hive_console_sdk::agent::UsageAgent::new(
             usage_config.token.clone(),
@@ -36,7 +36,7 @@ pub fn send_usage_report(
     operation_name: Option<&String>,
     operation_body: &str,
     usage_agent: &UsageAgent,
-    usage_config: &UsageConfig,
+    usage_config: &UsageReportingConfig,
     execution_result: &PlanExecutionOutput,
 ) {
     let mut rng = rand::rng();

docs/README.md

@@ -14,6 +14,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|
 
 **Additional Properties:** not allowed  
 **Example**
@@ -83,6 +84,7 @@ traffic_shaping:
   dedupe_enabled: true
   max_connections_per_host: 100
   pool_idle_timeout_seconds: 50
+usage_reporting: null
 
 ```
 
@@ -1740,4 +1742,45 @@ pool_idle_timeout_seconds: 50
 
 ```
 
+<a name="usage_reporting"></a>
+## usage\_reporting: object,null
+
+Configuration for usage reporting to GraphQL Hive.
+
+
+**Properties**
+
+|Name|Type|Description|Required|
+|----|----|-----------|--------|
+|**accept\_invalid\_certs**|`boolean`|Accepts invalid SSL certificates<br/>Default: false<br/>Default: `false`<br/>|no|
+|**buffer\_size**|`integer`|A maximum number of operations to hold in a buffer before sending to Hive Console<br/>Default: 1000<br/>Default: `1000`<br/>Format: `"uint"`<br/>Minimum: `0`<br/>|no|
+|**client\_name\_header**|`string`|Default: `"graphql-client-name"`<br/>|no|
+|**client\_version\_header**|`string`|Default: `"graphql-client-version"`<br/>|no|
+|**connect\_timeout**|`integer`|A timeout for only the connect phase of a request to Hive Console<br/>Unit: seconds<br/>Default: 5 (s)<br/>Default: `5`<br/>Format: `"uint64"`<br/>Minimum: `0`<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**|`integer`|Frequency of flushing the buffer to the server<br/>Default: 5 seconds<br/>Default: `5`<br/>Format: `"uint64"`<br/>Minimum: `0`<br/>|no|
+|**request\_timeout**|`integer`|A timeout for the entire request to Hive Console<br/>Unit: seconds<br/>Default: 15 (s)<br/>Default: `15`<br/>Format: `"uint64"`<br/>Minimum: `0`<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|
+|**target\_id**|`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.<br/>|yes|
+|**token**|`string`|Your [Registry Access Token](https://the-guild.dev/graphql/hive/docs/management/targets#registry-access-tokens) with write permission.<br/>|yes|
+
+**Additional Properties:** not allowed  
+**Example**
+
+```yaml
+{}
+
+```
+
+<a name="usage_reportingexclude"></a>
+### usage\_reporting\.exclude\[\]: array
+
+A list of operations (by name) to be ignored by Hive.
+Example: ["IntrospectionQuery", "MeQuery"]
+
+
+**Items**
+
+**Item Type:** `string`  
 

lib/router-config/src/lib.rs

@@ -9,7 +9,7 @@ pub mod primitives;
 pub mod query_planner;
 pub mod supergraph;
 pub mod traffic_shaping;
-pub mod usage;
+pub mod usage_reporting;
 
 use config::{Config, Environment, File, FileFormat, FileSourceFile};
 use schemars::JsonSchema;
@@ -72,7 +72,7 @@ pub struct HiveRouterConfig {
     pub override_subgraph_urls: override_subgraph_urls::OverrideSubgraphUrlsConfig,
     /// Configuration for usage reporting to GraphQL Hive.
     #[serde(default)]
-    pub usage: Option<usage::UsageConfig>,
+    pub usage_reporting: Option<usage_reporting::UsageReportingConfig>,
 }
 
 #[derive(Debug, thiserror::Error)]

lib/router-config/src/usage.rs renamed to lib/router-config/src/usage_reporting.rs

@@ -3,7 +3,7 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Debug, Deserialize, Serialize, JsonSchema, Clone)]
 #[serde(deny_unknown_fields)]
-pub struct UsageConfig {
+pub struct UsageReportingConfig {
     /// Your [Registry Access Token](https://the-guild.dev/graphql/hive/docs/management/targets#registry-access-tokens) with write permission.
     pub 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.