Skip to content

Jts-dar-522-3dist-partial-write-errors Improve write data troubleshooting for influxdb3 distributed #6296

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

jstirnaman
Copy link
Contributor

@jstirnaman jstirnaman commented Aug 11, 2025

Improve and enhance write data troubleshooting for influxdb3 distributed.
This standardizes troubleshooting across all InfluxDB 3 distributed editions.

  • Update clustered, cloud-dedicated, and cloud-serverless to share enhanced troubleshooting content
  • Add error capturing instructions with curl examples
  • Include client library debug logging samples (Python, Go, Java, JavaScript)
  • Provide detailed guidelines for reporting persistent write issues to support
  • Split HTTP status code tables for additional Serverless codes

Closes influxdata/DAR#522

Add 'partial writes' tag to frontmatter for better content discoverability:

  • content/influxdb3/cloud-dedicated/write-data/troubleshoot.md
  • content/influxdb3/cloud-serverless/write-data/troubleshoot.md
  • content/influxdb3/clustered/write-data/troubleshoot.md

- Update clustered, cloud-dedicated, and cloud-serverless to share enhanced troubleshooting content
- Add comprehensive error capturing instructions with curl examples
- Include client library debug logging samples (Python, Go, Java, JavaScript)
- Provide detailed guidelines for reporting persistent write issues to support
- Split HTTP status code tables by product type for clarity

This standardizes troubleshooting across all InfluxDB 3 distributed editions.

Closes influxdata/DAR#522
…ing pages

Add 'partial writes' tag to frontmatter for better content discoverability:
- content/influxdb3/cloud-dedicated/write-data/troubleshoot.md
- content/influxdb3/cloud-serverless/write-data/troubleshoot.md
- content/influxdb3/clustered/write-data/troubleshoot.md

This helps users find information about partial write scenarios across InfluxDB 3 distributed editions.
@jstirnaman jstirnaman changed the title Jts-dar-522-3dist-partial-write-errors Jts-dar-522-3dist-partial-write-errors Improve write data troubleshooting for influxdb3 distributed Aug 11, 2025
Comment on lines +130 to +141
{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}
```bash
# Example: Capture both successful and failed write attempts
curl --silent --show-error --write-out "\nHTTP Status: %{http_code}\nResponse Time: %{time_total}s\n" \
--request POST \
"https://{{< influxdb/host >}}/write?db=DATABASE_NAME&precision=ns" \
--header "Authorization: Bearer AUTH_TOKEN" \
--header "Content-Type: text/plain; charset=utf-8" \
--data-binary @problematic-data.lp \
> write-error-response.txt 2>&1
```
{{% /code-placeholders %}}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to ignore this, but I added a less-verbose, more stable way to do placeholders in code blocks.

Suggested change
{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}
```bash
# Example: Capture both successful and failed write attempts
curl --silent --show-error --write-out "\nHTTP Status: %{http_code}\nResponse Time: %{time_total}s\n" \
--request POST \
"https://{{< influxdb/host >}}/write?db=DATABASE_NAME&precision=ns" \
--header "Authorization: Bearer AUTH_TOKEN" \
--header "Content-Type: text/plain; charset=utf-8" \
--data-binary @problematic-data.lp \
> write-error-response.txt 2>&1
```
{{% /code-placeholders %}}
```bash { placeholders="AUTH_TOKEN|DATABASE_NAME" }
# Example: Capture both successful and failed write attempts
curl --silent --show-error --write-out "\nHTTP Status: %{http_code}\nResponse Time: %{time_total}s\n" \
--request POST \
"https://{{< influxdb/host >}}/write?db=DATABASE_NAME&precision=ns" \
--header "Authorization: Bearer AUTH_TOKEN" \
--header "Content-Type: text/plain; charset=utf-8" \
--data-binary @problematic-data.lp \
> write-error-response.txt 2>&1
```


If using a client library, enable debug logging and capture the full exception details:

{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{% code-placeholders "DATABASE_NAME|AUTH_TOKEN" %}}

[JavaScript](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
```python
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```python
```python { placeholders="DATABASE_NAME|AUTH_TOKEN" }

```
{{% /code-tab-content %}}
{{% code-tab-content %}}
```java
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```java
```java { placeholders="DATABASE_NAME|AUTH_TOKEN" }

```
{{% /code-tab-content %}}
{{% code-tab-content %}}
```javascript
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```javascript
```javascript { placeholders="DATABASE_NAME|AUTH_TOKEN" }

```
{{% /code-tab-content %}}
{{% code-tab-content %}}
```go
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```go
```go { placeholders="DATABASE_NAME|AUTH_TOKEN" }

```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
{{% /code-placeholders %}}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{% /code-placeholders %}}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants