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.

Sign up for GitHub

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

Jump to bottom

Implement a dynamic configuration documentation #1288

Closed
mariusoe opened this issue Feb 2, 2022 · 0 comments
Closed

Implement a dynamic configuration documentation #1288

mariusoe opened this issue Feb 2, 2022 · 0 comments
Assignees
@aaronweissler
Labels
area/config-server area/config-ui enhancement New feature or request Epic

Comments

@mariusoe
Copy link
Member

mariusoe commented Feb 2, 2022

As a user, I want to have an overview / documentation about all existing rules, scopes and action inside the configuration UI, so that I know which components I can use in my custom configuration and what they are doing.

Goal: In the configuration UI, a dialog/view can be opened showing a documentation about the existing configuration related to a agent mapping selected by the users. The documentation should contain rules, scopes and actions and their documentation (description, ...). The documentation should be updated as soon the underlying configuration changes.
mariusoe added a commit to mariusoe/inspectit-oce that referenced this issue Mar 3, 2022
@mariusoe
feat(ui): reload documentation when configuration files are changed
4905273 
Refs: inspectIT#1288
mariusoe added a commit to mariusoe/inspectit-oce that referenced this issue Mar 4, 2022
@mariusoe
feat(ui): ability to filter configuration docs
db860f4 
Refs: inspectIT#1288
@mariusoe mariusoe mentioned this issue Mar 4, 2022
Merged
mariusoe added a commit that referenced this issue Mar 4, 2022
@mariusoe
feat(ui): reload documentation when configuration files are changed (#…
61c7963 
…1340)

Refs: #1288
heiko-holz pushed a commit that referenced this issue Mar 14, 2022
Merge main into feature/opentelemetry-migration branch (#1350)
28dbc89 
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aaronweissler aaronweissler

Labels
area/config-server area/config-ui enhancement New feature or request Epic
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mariusoe @aaronweissler