feat(grpc): support FlatBuffers monitor constructs - #1487
Open
danielpaulus wants to merge 6 commits into
Open
danielpaulus wants to merge 6 commits into
danielpaulus wants to merge 6 commits into
Conversation
sorccu
reviewed
Sep 25, 2026
| - Use `grpcConfig.mode` to choose between `'BEHAVIOR'` (invoke a unary method) and `'HEALTH'` (standard health-check service). | ||
| - In `BEHAVIOR` mode, set `grpcConfig.method` (e.g. `'package.Service/Method'`). Use `grpcConfig.serviceDefinition` (`'REFLECTION'` or `'PROTO_FILE'`) to resolve the service definition. | ||
| - For a FlatBuffers service, compile the source schema locally with `flatc -b --schema --bfbs-builtins schema.fbs`. This produces `schema.bfbs`; `.fbs` is the source file and `.bfbs` is the compiled binary schema Checkly consumes. `--bfbs-builtins` preserves attributes used for streaming and nested FlatBuffers fields. | ||
| - Set `grpcConfig.encoding` to `'FLATBUFFERS'` and load the compiled schema with `bfbsContent: readFileSync('schema.bfbs').toString('base64')`. Do not set `serviceDefinition` or `protoContent` for FlatBuffers because FlatBuffers does not provide server reflection. |
Member
There was a problem hiding this comment.
Since this is not in a dedicated flatbuffers section, this, as a top level list item, reads to me as if it commands the agent to always set encoding to FLATBUFFERS. I'm sure it will figure it out but the instructions may not be as straightforward as they could be
sorccu
approved these changes
Sep 25, 2026
sorccu
left a comment
sorccu
left a comment
Member
There was a problem hiding this comment.
Added 1 minor comment about the agent instructions, but this looks alright to me.
This branch has not been deployed
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
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
.fbsschemas withflatcand loading.bfbsas base64Linear: https://linear.app/checklyhq/issue/RED-800/checkly-cli-flatbuffers-support-for-grpcmonitor
Validation
pnpm --filter checkly run test:typesgit diff --check