Skip to content

Commit 2f45816

Browse files
Copilottrask
andcommitted
Fix markdown copyediting issues: spelling, grammar, and formatting
Co-authored-by: trask <218610+trask@users.noreply.github.com>
1 parent bab56db commit 2f45816

4 files changed

Lines changed: 7 additions & 8 deletions

File tree

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,13 @@ from the OpenTelemetry Java Instrumentation project.
3636
See the [style guide](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/contributing/style-guideline.md).
3737
from the OpenTelemetry Java Instrumentation project.
3838

39-
## Running a smoke test in Intellij
39+
## Running a smoke test in IntelliJ
4040

4141
Pick the smoke test that you want to run, e.g. `MongoTest`.
4242
If the smoke test is abstract, then pick one of its subclasses, e.g. `MongoTest$Tomcat8Java8Test`.
4343
Right-click on it and select run.
4444

45-
## Debugging a smoke test in Intellij
45+
## Debugging a smoke test in IntelliJ
4646

4747
Add `-PsmokeTestRemoteDebug=true` to the gradle args, e.g.
4848

@@ -52,7 +52,7 @@ Then create a Remote JVM Debug configuration, e.g.
5252

5353
![Create a Remote JVM Debug configuration](docs/intellij-debug-smoke-test-part-2.png)
5454

55-
Then run (not debug) the smoke test as above in [Running the smoke tests from Intellij](#running-a-smoke-test-in-intellij).
55+
Then run (not debug) the smoke test as above in [Running the smoke tests from IntelliJ](#running-a-smoke-test-in-intellij).
5656

5757
The JVM inside the container will wait remote debugger to be attached before starting.
5858

agent/agent-profiler/request-triggers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Each individual configuration is formed of:
8181
supported type).
8282
- `profileDuration` - The duration in seconds of the profile to be collected when this SLA is
8383
breached.
84-
- `threshold` - The threshould applied to the output of the aggregation, if this value is breached a
84+
- `threshold` - The threshold applied to the output of the aggregation, if this value is breached a
8585
profile will be triggered, i.e the `breach-ratio` aggregation outputs the percentage of requests
8686
that breach the SLA, a threshold of 0.95 would trigger a profile if 95% of requests breach the
8787
SLA.

docs/README.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,7 @@ flags is found inside `Edit->Advanced` of this user interface.
6060
1. Browse to the Performance -> Profiler section of the associated Application Insights instance.
6161
2. Select "Triggers"
6262
3. Configure the required CPU and Memory thresholds. And Apply.
63-
4. Note, currently the Java profiler does not
64-
support the "Sampling" trigger, configuring this will have no effect.
63+
4. Note, currently the Java profiler does not support the "Sampling" trigger, configuring this will have no effect.
6564

6665
Once this has been completed, the agent will monitor the resource usage of your process and
6766
trigger a profile when required. Once a profile has been triggered and completed, it will be
@@ -112,5 +111,5 @@ This can be one of:
112111

113112
- `profile-without-env-data` (default value). A profile with certain sensitive events disabled, see
114113
[Warning](#Warning) section for details.
115-
- `profile`. Uses the `profile.jfc` jfc configuration that ships with JFR.
114+
- `profile`. Uses the `profile.jfc` configuration that ships with JFR.
116115
- A path to a custom jfc configuration file on the file system, i.e `/tmp/myconfig.jfc`.

etw/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Use the project property (`-P` option) `ai.etw.native.build` set to the desired
3737

3838
## Enabling verbose logging
3939

40-
The property `ai.etw.native.verbose` accepts a boolean value; when true, it enables verbose logging. This is done with preprocessor directives, so it must be rebuilt to enable. This slows execution time significantly under sufficient load. The build throws an error if this property is true for a relase build.
40+
The property `ai.etw.native.verbose` accepts a boolean value; when true, it enables verbose logging. This is done with preprocessor directives, so it must be rebuilt to enable. This slows execution time significantly under sufficient load. The build throws an error if this property is true for a release build.
4141

4242
* compile
4343
* Compiles the C++ sources.

0 commit comments

Comments
 (0)