Skip to content

Commit

Permalink
chore: markdown lint
Browse files Browse the repository at this point in the history
  • Loading branch information
blumamir committed May 11, 2024
1 parent 1602d53 commit 0c7a463
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
6 changes: 3 additions & 3 deletions GUIDELINES.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,6 @@ Instrumentation may add additional patch/unpatch messages for specific functions

The cases above are not covered by the base class and offer additional context to the user troubleshooting an issue with the instrumentation.


## Supported Versions

### Usage
Expand Down Expand Up @@ -234,11 +233,11 @@ Instrumentations SHOULD specify the supported versions of the instrumented packa

New major versions should be reviewed and tested by before being added to the supported versions list.

Versions should preferably be specified as a range, for example `>=1.2.3 <3`, as oppose to caret / tilde range `['^2.0.0']`, astrix syntax `['2.*']` or multiple consistent ranges `['4.*', '^5', '>=6 <6.4']`.
Versions should preferably be specified as a range, for example `>=1.2.3 <3`, as oppose to caret / tilde range `['^2.0.0']`, astrix syntax `['2.*']` or multiple consistent ranges `['4.*', '^5', '>=6 <6.4']`.

### Documentation

Instrumentations usually targets one or more users-facing packages to by automatically instrumented. Sometimes, the functions that ends up being patched are of internal modules or files which can carry different names and versions. Instrumentation can also choose to patch multiple modules of different versions to achieve it's goals.
Instrumentations usually targets one or more users-facing packages to by automatically instrumented. Sometimes, the functions that ends up being patched are of internal modules or files which can carry different names and versions. Instrumentation can also choose to patch multiple modules of different versions to achieve it's goals.

Instrumentation should document in it's README file, the supported versions range of the user-facing package. It should aim to give the range in short format of the form `>=x.y.z <w`, which hides any internal implementation details and focuses on relevance to the consumer. If the instrumentation patches multiple modules, it should list them in the documentation.

Expand All @@ -247,6 +246,7 @@ Instrumentation should document in it's README file, the supported versions rang
When a new major version of the instrumented package is released, renovate bot will open a PR in contrib which is an easy was to become aware of it. The instrumentation maintainer should review the new version and decide if it should be added to the supported versions list. Then a PR can add it to the list and it will be published in the next release.

Checklist for adding a new version to the supported versions list:

- Review which functions are patched by the instrumentation and if they were changed in the new version.
- Check for breaking changes in the new version that could affect the instrumentation.
- Test the instrumentation with the new version to ensure it works as expected.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ await client.execute('select * from foo');
| `enhancedDatabaseReporting` | `boolean` | `false` | Whether to include database queries with spans. These can contain sensitive information when using unescaped parameters - i.e. `insert into persons (name) values ('Bob')` instead of `insert into persons (name) values (?)`. |
| `responseHook` | `CassandraDriverResponseCustomAttributeFunction` | `undefined` | Hook for adding custom attributes before response is handled |
| `maxQueryLength` | `number` | `65536` | If `enhancedDatabaseReporting` is enabled, limits the attached query strings to this length. |

## Semantic Conventions

This package uses `@opentelemetry/semantic-conventions` version `1.22+`, which implements Semantic Convention [Version 1.7.0](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.7.0/semantic_conventions/README.md)
Expand Down

0 comments on commit 0c7a463

Please sign in to comment.