Skip to content

Commit c155aa9

Browse files
author
Wael Kdouh
committed
Updated documentation for enabling better diagnostics for extractor and publisher
1 parent ff21619 commit c155aa9

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

docs/apiops/3-apimTools/apiops-2-1-tools-extractor.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,17 @@ The tool expects certain configuration parameters. These can be passed as enviro
2222
| API_MANAGEMENT_SERVICE_OUTPUT_FOLDER_PATH | Folder where the APIM artifacts will be saved |
2323
| API_SPECIFICATION_FORMAT | OpenAPI specification format. Valid options are **JSON** or **YAML**. If the variable is missing or invalid, **YAML** will be used by default |
2424
| CONFIGURATION_YAML_PATH | Path to the Yaml configuration file used to specify select apis to extract. A sample yaml extractor configuration file to signal to the extractor to extract select apis. This is an optional parameter and will only come into play if you want different teams to manage different apis. You typically will have one configuration per team. Note: You can call the file whatever you want as long as you reference the right file within your extractor pipeline.
25+
| Logging__LogLevel__Default: | The allowed values are either "Information", "Debug", or "Trace". Table below shows the description of each logging level.
26+
27+
Here are the different logging levels available. By default the logging level is set to "Information".
28+
29+
| Log Level | Description |
30+
| - | - |
31+
| Information | Logs that track the general flow of the application. These logs should have long-term value |
32+
| Debug | Logs that are used for interactive investigation during development. These logs should primarily contain information useful for debugging and have no long-term value |
33+
| Trace | Logs that contain the most detailed messages. These messages may contain sensitive application data. These messages are disabled by default and should never be enabled in a production environment |
34+
35+
2536

2637
### API_SPECIFICATION_FORMAT
2738
The specification file format is controlled by the configuration variable ``API_SPECIFICATION_FORMAT``. Here are the options:

docs/apiops/3-apimTools/apiops-2-2-tools-publisher.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,16 @@ The tool expects certain configuration parameters. These can be passed as enviro
2222
| CONFIGURATION_YAML_PATH | Path to the Yaml configuration file used to override different configurations (e.g. policy backend value, namevalue pairs, just to name a few) when promoting across APIM environments (e.g. dev -> qa -> prod). You will need a unique Yaml configuration file per environment (e.g. configuration.prod.yaml for production) when overriding configurations across environments. More on this later on in the lab. |
2323
| COMMIT_ID | Git commit ID. If specified, the tool will only use files that were affected by that commit. New/modified files will be updated in Azure, and deleted artifacts will be removed from the Azure APIM instance. If unspecified, the tool will do a Put operation on the Azure APIM instance with all files in the artifacts folder. |
2424
| PUBLISH_CONFIGURATION_ARTIFACTS | If set to true, publisher will publish artifacts that are defined in configuration and exist in the artifacts directory. |
25+
| Logging__LogLevel__Default: | The allowed values are either "Information", "Debug", or "Trace". Table below shows the description of each logging level.
26+
27+
Here are the different logging levels available. By default the logging level is set to "Information".
28+
29+
| Log Level | Description |
30+
| - | - |
31+
| Information | Logs that track the general flow of the application. These logs should have long-term value |
32+
| Debug | Logs that are used for interactive investigation during development. These logs should primarily contain information useful for debugging and have no long-term value |
33+
| Trace | Logs that contain the most detailed messages. These messages may contain sensitive application data. These messages are disabled by default and should never be enabled in a production environment |
34+
2535

2636
>There are some interesting interactions with cases where we pass a commit ID. Here's the current behavior:
2737

0 commit comments

Comments
 (0)