Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closes #1329 - Fix parsing of Config-Yaml with unknown properties for Config-Docs #1330

Conversation

aaronweissler
Copy link
Member

@aaronweissler aaronweissler commented Mar 1, 2022

This change is Reviewable

@aaronweissler aaronweissler changed the title Closes #1329 - Fix parsing of Config-Yaml with invalid additional key at root level Closes #1329 - Fix parsing of Config-Yaml with unknown properties Mar 1, 2022
@aaronweissler aaronweissler force-pushed the bug/config-documentation-invalid-additional-root-key branch from a712bcf to c9dd25b Compare March 1, 2022 16:20
@aaronweissler aaronweissler force-pushed the bug/config-documentation-invalid-additional-root-key branch from c9dd25b to 9048232 Compare March 1, 2022 16:23
@aaronweissler aaronweissler changed the title Closes #1329 - Fix parsing of Config-Yaml with unknown properties Closes #1329 - Fix parsing of Config-Yaml with unknown properties for Config-Docs Mar 1, 2022
Copy link
Member

@mariusoe mariusoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 4 of 4 files at r1, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @aaronweissler)


components/inspectit-ocelot-configdocsgenerator/src/main/java/inspectit/ocelot/configdocsgenerator/parsing/ConfigParser.java, line 61 at r1 (raw file):

            // remove any invalid keys at the top level to make the String parseable for Jackson
            yamlMap.keySet().removeIf(key -> !key.equals("inspectit"));
            configYaml = mapper.writeValueAsString(yamlMap);

It is a matter of taste, but assigning new values to method arguments is often considered "bad pratice". It is "better" to use new variables instead, e.g. cleanedConfigYaml.


components/inspectit-ocelot-configdocsgenerator/src/test/java/inspectit/ocelot/configdocsgenerator/parsing/ConfigParserTest.java, line 96 at r1 (raw file):

        @Test
        void withAdditionalInvalidRootKey() throws IOException {

Remove the first empty line in the method bodies :)

@mariusoe mariusoe self-assigned this Mar 1, 2022
Copy link
Member Author

@aaronweissler aaronweissler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 2 of 4 files reviewed, 2 unresolved discussions (waiting on @mariusoe)


components/inspectit-ocelot-configdocsgenerator/src/main/java/inspectit/ocelot/configdocsgenerator/parsing/ConfigParser.java, line 61 at r1 (raw file):

Previously, mariusoe (Marius Oehler) wrote…

It is a matter of taste, but assigning new values to method arguments is often considered "bad pratice". It is "better" to use new variables instead, e.g. cleanedConfigYaml.

Done.


components/inspectit-ocelot-configdocsgenerator/src/test/java/inspectit/ocelot/configdocsgenerator/parsing/ConfigParserTest.java, line 96 at r1 (raw file):

Previously, mariusoe (Marius Oehler) wrote…

Remove the first empty line in the method bodies :)

Done.

Copy link
Member

@mariusoe mariusoe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 2 of 2 files at r2, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @aaronweissler)

@mariusoe mariusoe merged commit 3ae6a4f into inspectIT:master Mar 3, 2022
heiko-holz pushed a commit that referenced this pull request Mar 14, 2022
* Closes  #1291: Extend the Configuration UI to display Configuration Documentation (#1317)

Co-authored-by: Marius Oehler <[email protected]>

* Minor documentation fix (#1328)

* Closes #1318 - Only accept Maps as Config-Yaml content (#1320)

* Closes #1319 - Add filter for inspectit.env path in autocompletion (#1339)

* Add filter for inspectit.env path in autocompletion

* Update tests

* Closes #1329 - Fix parsing of Config-Yaml with unknown properties for Config-Docs (#1330)

* Closes #1159 - Close resources (#1160)

Co-authored-by: Marius Oehler <[email protected]>

* Closes #1284 - Agent command allows retrieving the latest logs (#1332)

* added logs method - actual functionality missing

* safe for the day

* added extractlogsappender

* add test case for config loading, basic fixes, and comments

* externalise preloaded logs into LogPreloader and add tests; rename ExtractLogsAppender into LogPreloadingAppender

* add comments what to do next

* add test case describing expected behavior of LogsCommandExecutor

* edited configuration for ´log output'

* debug prototype finished

* filter preloaded messages by log level and highlight open issues

* make the log preloader a DynamicallyActivatableService

* change config path to inspectit.log-preloading

* make logback initializer react to changes to self-monitoring or log-preloading

* format logs and rename command result attribute to logs

* adjust and fix test cases

* add default configuration and documentation

* cosmetic fixes

* further cosmetic stuff

* use correct mockito method

* add validation annotations to log preloading settings

* Merge branch 'master' into ocelot_debug_feature

* Closes #1248 - Refactor enabled field for exporters (#1303)

* Disable all exporters by default

* Update Documentation

* Test logging warnings

* Refactor enabled into enum

* Set log-level to warning

* Add changes to EUM server

* Unifrom javadoc for enabled field

* Add converter to support old configurations

* Fix log-level in EUM server

* Update breaking-changes.md

* Small fix to JavaDoc

* Re-add Info log

* Fix Attachment Test

* Fix agent_test.yml

* Fix agent_test.yml

* feat(exporter): [#1248] Minor refactoring of ExporterEnabledState.java and related exporter services; minor text/comment adjustment

* Small fixes to documentation

* Fix documentation in default config

* Fix agent_test.yml

* Debug attachment test

* Debug attachment test

* Debug attachment test

* Fix Attachment Test

* Remove Attachment Test debugging code

* Add Documentation to Converter

* Small fixes to Documentation

* Simplify tests

* feat(exporter): [#1248] small refactor  in `*ExporterServiceIntTest.java`

* Test TraceExportersConfiguration Annotations

* Fix TraceExportersConfiguration Test

* Fix EumExportersSettings

* Update TraceExportersConfigurationTest.java

* Added some Docs explaining the new test

* Add docs for metrics field in EumExportersSettings

Co-authored-by: Heiko Holz <[email protected]>

* feat(ui): reload documentation when configuration files are changed (#1340)

Refs: #1288

* feat(ui): ability to filter configuration docs (#1341)

* [skip ci] Publish documentation v1.15.0

* fix(config-docs) - Handle old Boolean style for enabled property (#1343)

Co-authored-by: Marius Oehler <[email protected]>

* [skip ci] Publish documentation v1.15.1

* fix(EUM-server): update Beacon Exporter enabled (#1344)

* fix(EUM-Server): Addition to Beacon exporter fix (#1345)

* fix(EUM-Server): Addition to Beacon exporter fix

* Small fixes to other exporter tests

* Add test for beacon exporter-related annotations

* fix(EUM-server): Add conversion-service to EUM server (#1346)

* Add conversionService to EUM-Server

* Refactor Conditional annotations

* Merge remote-tracking branch 'origin/master' into feature/opentelemetry-migration

# Conflicts:
#	components/inspectit-ocelot-configurationserver/src/test/java/rocks/inspectit/ocelot/autocomplete/autocompleterimpl/ModelAutoCompleterTest.java
#	inspectit-ocelot-core/src/main/java/rocks/inspectit/ocelot/core/exporter/JaegerExporterService.java
#	inspectit-ocelot-core/src/main/java/rocks/inspectit/ocelot/core/exporter/OpenCensusAgentMetricsExporterService.java
#	inspectit-ocelot-core/src/main/java/rocks/inspectit/ocelot/core/exporter/OpenCensusAgentTraceExporterService.java
#	inspectit-ocelot-core/src/main/java/rocks/inspectit/ocelot/core/exporter/PrometheusExporterService.java
#	inspectit-ocelot-core/src/main/java/rocks/inspectit/ocelot/core/exporter/ZipkinExporterService.java
#	inspectit-ocelot-core/src/test/java/rocks/inspectit/ocelot/core/exporter/JaegerExporterServiceIntTest.java
#	inspectit-ocelot-core/src/test/java/rocks/inspectit/ocelot/core/exporter/OpenCensusAgentMetricsExporterServiceIntTest.java
#	inspectit-ocelot-core/src/test/java/rocks/inspectit/ocelot/core/exporter/OpenCensusAgentTraceExporterServiceIntTest.java
#	inspectit-ocelot-core/src/test/java/rocks/inspectit/ocelot/core/exporter/PrometheusExporterServiceIntTest.java
#	inspectit-ocelot-core/src/test/java/rocks/inspectit/ocelot/core/exporter/ZipkinExporterServiceIntTest.java
#	inspectit-ocelot-documentation/docs/metrics/metric-exporters.md
#	inspectit-ocelot-documentation/docs/tracing/trace-exporters.md
@aaronweissler aaronweissler deleted the bug/config-documentation-invalid-additional-root-key branch June 7, 2022 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants