APM Server specification validation #984
Merged
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #984 +/- ##
==========================================
- Coverage 79.26% 74.05% -5.22%
==========================================
Files 151 157 +6
Lines 7472 7945 +473
==========================================
- Hits 5923 5884 -39
- Misses 1549 2061 +512
Continue to review full report at Codecov.
|
💔 Tests Failed
Expand to view the summary
Build stats
Test stats 🧪
Test errors
Expand to view the tests failures> Show only the first 10 test failures
|
russcam
force-pushed
the
feature/schema-validation
branch
from
22d28cb
to
355ddd1
Compare
|
As discussed with @gregkalapos, I've reverted the changes to the Agent types that transformed it into a complete reference implementation of the APM server schema specs. The validator still has the ability to perform this validation, with the test to perform this marked as skip for now. This is now ready for review. |
russcam
force-pushed
the
feature/schema-validation
branch
from
355ddd1
to
390ba31
Compare
gregkalapos
requested changes
Dec 2, 2020
There was a problem hiding this comment.
elastic/apm-server#4427 made some changes on where json files are. I tried to adapt this PR to the changes, but then I run into some NullReferenceExceptions.
But overall, this looks very nice! 👍
work in progress
This commit adds a service property to span context.
This commit validates the input to the mock APM server against the APM server specification JSON schema.
russcam
force-pushed
the
feature/schema-validation
branch
from
390ba31
to
b2b83b1
Compare
gregkalapos
approved these changes
Dec 22, 2020
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.
This PR introduces validation against the APM server JSON schema specification. Validation is performed in two ways:
Validate agent types against the schema through reflection.
It's possible to statically validate a large part of the agent types against the JSON schema. Where it is not possible is where agent types model the APM server specification with a structure that cannot be statically mapped to the schema properties, typically because such types have a custom JSON serialization routine that transforms instances of types to a JSON structure that matches the specification.
Validate JSON input to mock APM server against the JSON schema.
This PR makes changes to the agent types in order for them to exactly match the schema. For example, the
sampledfield can be"null"or"boolean"within the specification, but the agent models as abool. In chatting to @gregkalapos, it might make sense to model the specification as a set of POCOs, and leave the agent types as an implementation of the spec as opposed to an exact implementation of the spec. In modelling the spec as POCOs, these could be used outside of the agent, for example, to transform some output to an APM server input, or used by the mock APM server.