docs: Add comprehensive troubleshooting for Data Explorer ingestion pipeline errors #1850
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Users deploying FinOps hubs are encountering a confusing error message in the
ingestion_ETL_dataexplorerpipeline: "Failed to interpret Post-Ingest Drop Failed Error fail message or error code" with error codeErrorCodeNotString. This error message doesn't explain the actual root cause, making it difficult for users to diagnose and resolve the issue.Based on the screenshots in the issue, the error appears as:
Root Cause
This is a known Azure Data Factory behavior documented in Microsoft Learn. The
ErrorCodeNotStringerror occurs when:Post-Ingest Cleanup,Pre-Ingest Cleanup, orIngest Data) failsErrorCodeNotStringThis is a secondary error - the real issue is why the underlying Data Explorer activity failed (commonly capacity exhaustion, permission issues, command syntax errors, or network problems).
Solution
This PR enhances the FinOps toolkit error documentation to help users:
ErrorCodeNotStringis a symptom, not the root causeChanges Made
1. New ErrorCodeNotString Documentation
Added a comprehensive error entry for
ErrorCodeNotStringwith:2. Enhanced DataExplorerPostIngestionDropFailed Documentation
Expanded the existing error entry with:
ErrorCodeNotStringvariant3. Enhanced DataExplorerPreIngestionDropFailed Documentation
Added troubleshooting guidance with:
ErrorCodeNotStringfor the same error patternDataExplorerPostIngestionDropFailedguidance4. Updated Changelog
Documented these documentation improvements in the "Unreleased" section under "Documentation improvements".
Impact
These documentation enhancements will help users:
ErrorCodeNotStringand the underlying Data Explorer errorsTesting
References
All guidance is based on official Microsoft documentation:
Closes #[issue_number]
Original prompt
Fixes #1809
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.