diff --git a/src/timestream-for-influxdb-mcp-server/kiro_power/steering/getting-started.md b/src/timestream-for-influxdb-mcp-server/kiro_power/steering/getting-started.md index bb6775d4d7..7f72023d1c 100644 --- a/src/timestream-for-influxdb-mcp-server/kiro_power/steering/getting-started.md +++ b/src/timestream-for-influxdb-mcp-server/kiro_power/steering/getting-started.md @@ -8,6 +8,8 @@ For all documentation and guides related to InfluxDB 2 (Timestream for InfluxDB) ## Best Practices +- SHOULD refer to [`influxdb2/onboarding.md`](./influxdb2/onboarding.md) when getting started with Timestream for InfluxDB 2. +- SHOULD refer to [`influxdb3/onboarding.md`](./influxdb3/onboarding.md) when getting started with Timestream for InfluxDB 3. - SHOULD ask user about which version of InfluxDB they are using if not specified. - SHOULD refer to [`influxdb-2-vs-3.md`](./influxdb-2-vs-3.md) when working across both versions. - SHOULD refer to [`line-protocol.md`](./line-protocol.md) when dealing with Line Protocol. diff --git a/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb2/schema-design.md b/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb2/schema-design.md index 661f743c33..a8bc1a67cb 100644 --- a/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb2/schema-design.md +++ b/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb2/schema-design.md @@ -9,7 +9,7 @@ | Logical grouping | Measurement | Table (auto-created from measurement) | | Indexed metadata | Tags (string only) | Tags → columns (indexed) | | Value storage | Fields | Fields → columns (non-indexed) | -| Retention config | `retentionRules[].everySeconds` | `retentionPeriod` (e.g. `"30d"`) | +| Retention config | `retentionRules[].everySeconds` | `retention_period` (e.g. `"30d"`) | | Series cardinality | ~10M typical threshold (varies by instance) | Virtually unlimited | | Query language | Flux (primary), InfluxQL | SQL (primary), InfluxQL | diff --git a/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb3/ingestion.md b/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb3/ingestion.md index afc6bdc761..0edcfb6995 100644 --- a/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb3/ingestion.md +++ b/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb3/ingestion.md @@ -35,7 +35,7 @@ Content-Type: text/plain - Target **5,000+ points per request** minimum - Optimal batch size: 5,000–10,000 points - Max recommended: ~50,000 points per request (beyond this, HTTP timeouts become a risk) -- For high-throughput workloads, tune write timeout in the parameter group (see Tuning section below) +- For high-throughput workloads, tune `ingestQueryInstances` in the parameter group (see Tuning section below) or scale vertically by updating the cluster size with the `--db-instance-type` option (with the AWS CLI). ## Python Client diff --git a/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb3/schema-design.md b/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb3/schema-design.md index 27b22562f1..1b18bbb9fa 100644 --- a/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb3/schema-design.md +++ b/src/timestream-for-influxdb-mcp-server/kiro_power/steering/influxdb3/schema-design.md @@ -9,7 +9,7 @@ | Logical grouping | Measurement | Table (auto-created from measurement) | | Indexed metadata | Tags (string only) | Tags → columns (indexed) | | Value storage | Fields | Fields → columns (non-indexed) | -| Retention config | `retentionRules[].everySeconds` | `retentionPeriod` (e.g. `"30d"`) | +| Retention config | `retentionRules[].everySeconds` | `retention_period` (e.g. `"30d"`) | | Series cardinality | ~10M typical threshold (varies by instance) | Virtually unlimited | | Query language | Flux (primary), InfluxQL | SQL (primary), InfluxQL | @@ -65,7 +65,7 @@ Design principle: same as V2 — **one database per retention period**. Guidance: - Create databases via `POST /api/v3/configure/database`. -- Retention is set via `retentionPeriod` (e.g. `"7d"`, `"90d"`, `"1y"`). Null or omitted = infinite. +- Retention is set via `retention_period` (e.g. `"7d"`, `"90d"`, `"1y"`). Null or omitted = infinite. - Tables are limited to **10,000 across all databases** (default) — plan measurement names accordingly. - Each table is limited to **500 columns** (1 timestamp + up to 499 tag/field keys). @@ -83,7 +83,7 @@ curl -X POST "https://:8181/api/v3/configure/database" \ ## Retention Policy -Retention is configured per database via `retentionPeriod` using human-readable durations (`"7d"`, `"30d"`, `"1y"`). Null = infinite. +Retention is configured per database via `retention_period` using human-readable durations (`"7d"`, `"30d"`, `"1y"`). Null = infinite. Update retention via `PATCH /api/v3/configure/database/{name}`. To clear retention (keep data indefinitely), use `DELETE /api/v3/configure/database/retention?db=`.