Skip to content

Commit 6faec63

Browse files
clarify documentation (#2298)
Co-authored-by: otelbot <[email protected]>
1 parent 595a3ff commit 6faec63

File tree

3 files changed

+24
-14
lines changed

3 files changed

+24
-14
lines changed

ibm-mq-metrics/README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,17 @@ java \
8383
./my-config.yml
8484
```
8585

86+
## Generate code with Weaver
87+
88+
Weaver generates code, documentation and configuration for this program.
89+
90+
```shell
91+
make generate
92+
```
93+
94+
This generates `config.yaml`, the `docs` folder, the `src/main/java/io/opentelemetry/ibm/mq/metrics`
95+
Java code folder.
96+
8697
## Connection
8798

8899
There are two transport modes in which this extension can be run:
@@ -147,12 +158,11 @@ _Note: The following is only needed for versions of Java 8 before 8u161._
147158
148159
**Note** : Please make sure to not use tab (\t) while editing yaml files. You may want to validate
149160
the yaml file using a [yaml validator](https://jsonformatter.org/yaml-validator). Configure the monitor by copying and editing the
150-
config.yml file in <code>src/main/resources/config.yml</code>.
161+
config.yml file.
151162
152163
1. Configure the queueManagers with appropriate fields and filters. You can configure multiple
153164
queue managers in one configuration file.
154165
2. To run the extension at a frequency > 1 minute, please configure the taskSchedule section.
155-
Refer to the [Task Schedule](https://community.appdynamics.com/t5/Knowledge-Base/Task-Schedule-for-Extensions/ta-p/35414) doc for details.
156166
157167
### Monitoring Workings - Internals
158168

ibm-mq-metrics/config.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
#Run it as a scheduled task instead of running every minute.
2-
#If you want to run this every minute, comment this out
3-
#taskSchedule:
4-
# numberOfThreads: 20
5-
# taskDelaySeconds: 300
1+
# This section defines the schedule at which the program will scrape metrics.
2+
taskSchedule:
3+
numberOfThreads: 20
4+
initialDelaySeconds: 0
5+
taskDelaySeconds: 60
66

77
#This is the timeout on queue metrics and channel metrics threads.Default value is 20 seconds.
88
#No need to change the default unless you know what you are doing.
@@ -210,4 +210,4 @@ sslConnection:
210210

211211
# Configure the OTLP exporter using system properties keys following the specification https://opentelemetry.io/docs/languages/java/configuration/
212212
otlpExporter:
213-
otel.exporter.otlp.endpoint: http://localhost:4318
213+
otel.exporter.otlp.endpoint: http://localhost:4318

ibm-mq-metrics/templates/registry/yaml/config.yml.j2

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
#Run it as a scheduled task instead of running every minute.
2-
#If you want to run this every minute, comment this out
3-
#taskSchedule:
4-
# numberOfThreads: 20
5-
# taskDelaySeconds: 300
1+
# This section defines the schedule at which the program will scrape metrics.
2+
taskSchedule:
3+
numberOfThreads: 20
4+
initialDelaySeconds: 0
5+
taskDelaySeconds: 60
66

77
#This is the timeout on queue metrics and channel metrics threads.Default value is 20 seconds.
88
#No need to change the default unless you know what you are doing.
@@ -122,4 +122,4 @@ sslConnection:
122122

123123
# Configure the OTLP exporter using system properties keys following the specification https://opentelemetry.io/docs/languages/java/configuration/
124124
otlpExporter:
125-
otel.exporter.otlp.endpoint: http://localhost:4318
125+
otel.exporter.otlp.endpoint: http://localhost:4318

0 commit comments

Comments
 (0)