Conversation
…nd KQL shapes Closes #79 - Add a scope disclaimer in the README 'What it does' section: this package writes structured JSON to Python logging / stdout; how those fields appear in Application Insights depends on the host, worker, logging configuration, and ingestion pipeline. The library does not own ingestion or schema mapping. - Document precise cold_start semantics in both README and docs/usage.md: cold_start=True means the first invocation observed by this Python worker process after module load, not a platform-level cold start metric. It does not correspond to App Service plan / instance allocation cold starts. - Split the README KQL examples into two ingestion shapes: one for the customDimensions-parsed shape and one for the raw-message shape using parse_json(message). Both are valid in real deployments.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #79
Summary
P2 documentation accuracy fixes from the external review. Pure docs change — no source modifications.
1. Application Insights scope disclaimer (early in README)
Added a
Scope disclaimercallout immediately after the What it does bullet list, before any KQL example. The previous "Application Insights-ready" framing was technically accurate but implicit — the disclaimer existed only midway through the README, after readers had already seen examples assumingcustomDimensionsparsing.The new disclaimer states plainly: this package writes structured JSON to Python
logging/ stdout. How those fields appear in Application Insights depends on the Azure Functions host, worker, logging configuration, and ingestion pipeline. The library does not own ingestion or schema mapping. BothcustomDimensions-parsed and raw-messageshapes are valid in production.2.
cold_startsemantics documented preciselyAdded a callout in both README (
Invocation Contextsection) and docs/usage.md (Cold Start Detectionsection):This matches the actual implementation:
_cold_startis a process-global flag flipped on the firstinject_context()call after module import. It is informational for log correlation, not a substitute for Azure metrics.3. KQL examples split into both ingestion shapes
The README Query in Application Insights section now has two clearly labeled subsections:
customDimensions— the original queries.messagecolumn — same queries rewritten withparse_json(message)andtostring(payload.<field>).Both shapes occur in real Azure Functions deployments depending on the worker, host configuration, and Application Insights connection mode. Documenting only the parsed shape misled users whose payloads land as raw text.
Validation
make lint— clean (no source files touched, but README/docs changes verified through pre-commit hooks)make test— 142 passed, 3 skipped, 97.05% coverageAcceptance checklist (from #79)
cold_startsemantics documented in README anddocs/usage.md