Polish OAL, MAL, and LAL documentation #13673
Merged
+38
−26
Conversation
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
- OAL: Add cpm function docs, improve filter operators formatting, clarify downsampling/TimeBucket behavior - MAL: Fix typos (valueNotEqual, tagNotMatch, combinates, fourse), fix wrong region in example, add missing Layer param to endpoint - LAL: Fix endpoint description, fix extractor typo, clarify rpm rate limit comments, remove grok TODO - CLAUDE.md: Add tips for markdown rendering and relative paths
wu-sheng
added
documentation
wankai123
approved these changes
Jan 19, 2026
There was a problem hiding this comment.
Pull request overview
This PR polishes the documentation for OAL (Observability Analysis Language), MAL (Meter Analysis Language), and LAL (Log Analysis Language) by fixing typos, improving formatting, adding missing documentation, and clarifying behavior.
Changes:
- Fixed multiple typos across documentation files (e.g., "valueNotEqual" description, "tagNotMatch" description, "combinates" → "combines")
- Improved filter operators documentation in OAL with categorized list format
- Added missing
cpmfunction documentation and clarified downsampling behavior in OAL - Added
Layerparameter toendpointfunction signature in MAL - Fixed incorrect region reference in MAL binary operator example
- Corrected
endpointextractor description in LAL and removed outdatedgrok (TODO)section - Added helpful tips for AI assistants in CLAUDE.md
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/en/concepts-and-designs/oal.md | Fixed typo, reorganized filter operators with categories, added cpm function docs, clarified downsampling behavior, updated examples to use percentile2 |
| docs/en/concepts-and-designs/mal.md | Fixed typos in filter descriptions, corrected region in example, added missing Layer parameter to endpoint function, fixed "combinates" typo |
| docs/en/concepts-and-designs/lal.md | Fixed endpoint extractor description, corrected grammar, clarified rpm rate limit comments, removed outdated grok section, fixed "extractors" typo |
| CLAUDE.md | Added documentation tips about markdown rendering and relative path handling |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Comparison: `==`, `!=`, `>`, `<`, `>=`, `<=` | ||
| - Collection: `in [...]` (e.g., `name in ("Endpoint1", "Endpoint2")`) | ||
| - String matching: `like %...`, `like ...%`, `like %...%` (e.g., `name like "serv%"`) | ||
| - Tag matching: `contain`, `not contain` (e.g., `tags contain "http.method:GET"`) |
There was a problem hiding this comment.
Trailing whitespace detected at the end of this line. Consider removing it for consistency with coding standards.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
cpmfunction documentation, improve filter operators formatting with categorized list, clarify downsampling/TimeBucket behaviorvalueNotEqual,tagNotMatch,combinates,fourse), fix wrong region in binary operator example, add missingLayerparameter toendpointfunction signatureendpointdescription (was copy-pasted from instance), fixextractorstypo toextractor, clarifyrpmrate limit comments, removegrok (TODO)sectionTest plan
🤖 Generated with Claude Code