Spelling

.github/workflows/generate_workflows_lib/src/generate_workflows_lib/__init__.py

@@ -173,7 +173,7 @@ def get_misc_job_datas(tox_envs: list) -> list:
 def _generate_workflow(
     job_datas: list, name: str, workflow_directory_path: Path, max_jobs=250
 ):
-    # Github seems to limit the amount of jobs in a workflow file, that is why
+    # GitHub seems to limit the amount of jobs in a workflow file, that is why
     # they are split in groups of 250 per workflow file.
     for file_number, job_datas in enumerate(
         [

CHANGELOG.md

@@ -503,7 +503,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#1879](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1879))
 - Add optional distro and configurator selection for auto-instrumentation
   ([#1823](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1823))
-- `opentelemetry-instrumentation-django` - Add option to add Opentelemetry middleware at specific position in middleware chain
+- `opentelemetry-instrumentation-django` - Add option to add OpenTelemetry middleware at specific position in middleware chain
   ([#2912]https://github.com/open-telemetry/opentelemetry-python-contrib/pull/2912)
 
 ### Added
@@ -536,7 +536,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#1762](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1762))
 - `opentelemetry-instrumentation-celery` Add support for anonymous tasks.
   ([#1407](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1407))
-- `opentelemetry-instrumentation-logging` Add `otelTraceSampled` to instrumetation-logging
+- `opentelemetry-instrumentation-logging` Add `otelTraceSampled` to instrumentation-logging
   ([#1773](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1773))
 
 ### Changed
@@ -620,7 +620,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#1575](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1575))
 - Fix SQLAlchemy uninstrumentation
   ([#1581](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1581))
-- `opentelemetry-instrumentation-grpc` Fix code()/details() of \_OpentelemetryServicerContext.
+- `opentelemetry-instrumentation-grpc` Fix code()/details() of \_OpenTelemetryServicerContext.
   ([#1578](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1578))
 - Fix aiopg instrumentation to work with aiopg < 2.0.0
   ([#1473](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1473))
@@ -702,7 +702,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `opentelemetry-instrumentation-django` Fixed bug where auto-instrumentation fails when django is installed and settings are not configured.
   ([#1369](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1369))
 - `opentelemetry-instrumentation-system-metrics` add supports to collect system thread count. ([#1339](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1339))
-- `opentelemetry-exporter-richconsole` Fixing RichConsoleExpoter to allow multiple traces, fixing duplicate spans and include resources ([#1336](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1336))
+- `opentelemetry-exporter-richconsole` Fixing RichConsoleExporter to allow multiple traces, fixing duplicate spans and include resources ([#1336](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1336))
 - `opentelemetry-instrumentation-asgi` Add support for regular expression matching and sanitization of HTTP headers.
   ([#1333](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1333))
 - `opentelemetry-instrumentation-asgi` metrics record target attribute (FastAPI only)
@@ -730,7 +730,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#1377](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1377))
 - `opentelemetry-instrumentation-asgi` Fix keys() in class ASGIGetter so it decodes the keys before returning them.
   ([#1333](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1333))
-- `opentelemetry-instrumentation-asgi` Make ASGIGetter.get() compare all keys in a case insensitive manner.
+- `opentelemetry-instrumentation-asgi` Make ASGIGetter.get() compare all keys in a case-insensitive manner.
   ([#1333](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1333))
 - Use resp.text instead of resp.body for Falcon 3 to avoid a deprecation warning.
   ([#1412](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1412))
@@ -828,7 +828,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#1117](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1117))
 - `opentelemetry-instrumentation-remoulade` Initial release
   ([#1082](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1082))
-- Added `opentelemetry-instrumention-confluent-kafka`
+- Added `opentelemetry-instrumentation-confluent-kafka`
   ([#1111](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1111))
 - Set otlp-proto-grpc as the default metrics exporter for auto-instrumentation
   ([#1127](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1127))
@@ -984,7 +984,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `opentelemetry-instrumentation-pymongo` now supports `pymongo v4`
   ([#876](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/876))
 
-- `opentelemetry-instrumentation-httpx` now supports versions higher than `0.19.0`.
+- `opentelemetry-instrumentation-httpx` now supports versions greater than `0.19.0`.
   ([#866](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/866))
 
 ### Fixed
@@ -1109,7 +1109,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#667](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/667))
 - `opentelemetry-instrumentation-urllib3`, `opentelemetry-instrumentation-requests`
   The `net.peer.ip` attribute is set to the IP of the connected HTTP server or proxy
-  using a new instrumentor in `opententelemetry-util-http`
+  using a new instrumentor in `opentelemetry-util-http`
   ([#661](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/661))
 - `opentelemetry-instrumentation-pymongo` Add check for suppression key in PyMongo.
   ([#736](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/736))
@@ -1165,7 +1165,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `opentelemetry-sdk-extension-aws` Add AWS resource detectors to extension package
   ([#586](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/586))
-- `opentelemetry-instrumentation-asgi`, `opentelemetry-instrumentation-aiohttp-client`, `openetelemetry-instrumentation-fastapi`,
+- `opentelemetry-instrumentation-asgi`, `opentelemetry-instrumentation-aiohttp-client`, `opentelemetry-instrumentation-fastapi`,
   `opentelemetry-instrumentation-starlette`, `opentelemetry-instrumentation-urllib`, `opentelemetry-instrumentation-urllib3` Added `request_hook` and `response_hook` callbacks
   ([#576](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/576))
 - `opentelemetry-instrumentation-pika` added RabbitMQ's pika module instrumentation.
@@ -1217,7 +1217,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#566](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/566))
 - Include Flask 2.0 as compatible with existing flask instrumentation
   ([#545](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/545))
-- `openelemetry-sdk-extension-aws` Take a dependency on `opentelemetry-sdk`
+- `opentelemetry-sdk-extension-aws` Take a dependency on `opentelemetry-sdk`
   ([#558](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/558))
 - Change `opentelemetry-instrumentation-httpx` to replace `client` classes with instrumented versions.
   ([#577](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/577))
@@ -1321,23 +1321,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `opentelemetry-instrumentation-flask` Added `request_hook` and `response_hook` callbacks.
   ([#416](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/416))
 
-- `opentelemetry-instrumenation-django` now supports request and response hooks.
+- `opentelemetry-instrumentation-django` now supports request and response hooks.
   ([#407](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/407))
 - `opentelemetry-instrumentation-falcon` FalconInstrumentor now supports request/response hooks.
   ([#415](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/415))
 - `opentelemetry-instrumentation-tornado` Add request/response hooks.
   ([#426](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/426))
 - `opentelemetry-exporter-datadog` Add parsing exception events for error tags.
   ([#459](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/459))
-- `opentelemetry-instrumenation-django` now supports trace response headers.
+- `opentelemetry-instrumentation-django` now supports trace response headers.
   ([#436](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/436))
-- `opentelemetry-instrumenation-tornado` now supports trace response headers.
+- `opentelemetry-instrumentation-tornado` now supports trace response headers.
   ([#436](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/436))
-- `opentelemetry-instrumenation-pyramid` now supports trace response headers.
+- `opentelemetry-instrumentation-pyramid` now supports trace response headers.
   ([#436](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/436))
-- `opentelemetry-instrumenation-falcon` now supports trace response headers.
+- `opentelemetry-instrumentation-falcon` now supports trace response headers.
   ([#436](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/436))
-- `opentelemetry-instrumenation-flask` now supports trace response headers.
+- `opentelemetry-instrumentation-flask` now supports trace response headers.
   ([#436](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/436))
 - `opentelemetry-instrumentation-grpc` Keep client interceptor in sync with grpc client interceptors.
   ([#442](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/442))
@@ -1391,7 +1391,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Remove `component` span attribute in instrumentations.
   `opentelemetry-instrumentation-aiopg`, `opentelemetry-instrumentation-dbapi` Remove unused `database_type` parameter from `trace_integration` function.
   ([#301](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/301))
-- `opentelemetry-instrumentation-asgi` Return header values using case insensitive keys
+- `opentelemetry-instrumentation-asgi` Return header values using case-insensitive keys
   ([#308](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/308))
 - Remove metrics from all instrumentations
   ([#312](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/312))

CONTRIBUTING.md

@@ -248,7 +248,7 @@ Some of the tox targets install packages from the [OpenTelemetry Python Core Rep
 CORE_REPO_SHA=c49ad57bfe35cfc69bfa863d74058ca9bec55fc3 tox
 ```
 
-The continuous integration overrides that environment variable with as per the configuration [here](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/test_0.yml#L14).
+The continuous integration overrides that environment variable with as per [the configuration](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/.github/workflows/test_0.yml#L14).
 
 ## Style Guide
 
@@ -263,15 +263,15 @@ The continuous integration overrides that environment variable with as per the c
 Below is a checklist of things to be mindful of when implementing a new instrumentation or working on a specific instrumentation. It is one of our goals as a community to keep the implementation specific details of instrumentations as similar across the board as possible for ease of testing and feature parity. It is also good to abstract as much common functionality as possible.
 
 - Follow semantic conventions
-  - The instrumentation should follow the semantic conventions defined [here](https://github.com/open-telemetry/semantic-conventions/tree/main/docs).
+  - The instrumentation should follow the [semantic conventions](https://github.com/open-telemetry/semantic-conventions/tree/main/docs).
   - To ensure consistency, we encourage contributions that align with [STABLE](https://opentelemetry.io/docs/specs/otel/document-status/#lifecycle-status) semantic conventions if available. This approach helps us avoid potential confusion and reduces the need to support multiple outdated versions of semantic conventions. However, we are still open to considering exceptional cases where changes are well justified.
   - Contributions related to outdated HTTP semantic conventions (conventions prior to becoming [stable](https://github.com/open-telemetry/semantic-conventions/tree/v1.23.0)) will likely be discouraged, as they increase complexity and the potential for misconceptions.
 - Contains a name that is not already claimed in [Pypi](https://pypi.org/). Contact a maintainer, bring the issue up in the weekly Python SIG or create a ticket in Pypi if a desired name has already been taken.
 - Extends from [BaseInstrumentor](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py#L35)
 - Supports auto-instrumentation
   - Add an entry point (ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/instrumentation/opentelemetry-instrumentation-requests/pyproject.toml#L44>)
   - Run `python scripts/generate_instrumentation_bootstrap.py` after adding a new instrumentation package.
-- Functionality that is common amongst other instrumentation and can be abstracted [here](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation)
+- Functionality that is [common amongst other instrumentation and can be abstracted](https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/opentelemetry-instrumentation/src/opentelemetry/instrumentation)
 - Request/response [hooks](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/408) for http instrumentations
 - `suppress_instrumentation` functionality
   - ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/2518a4ac07cb62ad6587dd8f6cbb5f8663a7e179/opentelemetry-instrumentation/src/opentelemetry/instrumentation/utils.py#L191>
@@ -290,7 +290,7 @@ Below is a checklist of things to be mindful of when implementing a new instrume
   - ex. <https://github.com/open-telemetry/opentelemetry-python-contrib/blob/60fb936b7e5371b3e5587074906c49fb873cbd76/instrumentation/opentelemetry-instrumentation-grpc/tests/test_aio_server_interceptor.py#L84>
 - Most of the instrumentations have the same version. If you are going to develop a new instrumentation it would probably have `X.Y.dev` version and depends on `opentelemetry-instrumentation` and `opentelemetry-semantic-conventions` for a [compatible version](https://peps.python.org/pep-0440/#compatible-release). That means that you may need to install the instrumentation dependencies from this repo and the core repo from git.
 - Documentation
-  - When adding a new instrumentation remember to add an entry in `docs/instrumentation/` named `<instrumentation>/<instrumentation>.rst` to have the instrumentation documentation referenced from the index. You can use the entry template available [here](./_template/autodoc_entry.rst)
+  - When adding a new instrumentation remember to add an entry in `docs/instrumentation/` named `<instrumentation>/<instrumentation>.rst` to have the instrumentation documentation referenced from the index. You can use the [entry template](./_template/autodoc_entry.rst)
 - Testing
   - When adding a new instrumentation remember to update `tox.ini` adding appropriate rules in `envlist`, `command_pre` and `commands` sections
 

RELEASING.md

@@ -68,7 +68,7 @@ The workflow will create a pull request that should be merged in order to procee
   * Review and merge the pull request that it creates for updating the change log in main
     (note that if this is not a patch release then the change log on main may already be up-to-date,
     in which case no pull request will be created).
-  * Verify that a new [Github release](https://github.com/open-telemetry/opentelemetry-python-contrib/releases) has been created and that the CHANGELOGs look correct.
+  * Verify that a new [GitHub release](https://github.com/open-telemetry/opentelemetry-python-contrib/releases) has been created and that the CHANGELOGs look correct.
 
 ### Releasing individual package
 

docs/conf.py

@@ -105,7 +105,7 @@
     # Add a .nojekyll file to the generated HTML docs
     # https://help.github.com/en/articles/files-that-start-with-an-underscore-are-missing
     "sphinx.ext.githubpages",
-    # Support external links to different versions in the Github repo
+    # Support external links to different versions in the GitHub repo
     "sphinx.ext.extlinks",
 ]
 
@@ -182,7 +182,7 @@ def getlistcfg(strval):
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = []
 
-# Support external links to specific versions of the files in the Github repo
+# Support external links to specific versions of the files in the GitHub repo
 branch = os.environ.get("READTHEDOCS_VERSION")
 if branch is None or branch == "latest":
     branch = "main"

exporter/opentelemetry-exporter-prometheus-remote-write/example/README.md

@@ -14,7 +14,7 @@ data
 *Users do not need to install Python as the app will be run in the Docker Container*
 
 ## Instructions
-1. Run `docker-compose up -d` in the the `example/` directory
+1. Run `docker-compose up -d` in the `example/` directory
 
 The `-d` flag causes all services to run in detached mode and frees up your
 terminal session. This also causes no logs to show up. Users can attach themselves to the service's logs manually using `docker logs ${CONTAINER_ID} --follow`

exporter/opentelemetry-exporter-prometheus-remote-write/src/opentelemetry/exporter/prometheus_remote_write/__init__.py

@@ -296,7 +296,7 @@ def _sanitize_string(string: str, type_: str) -> str:
             raise TypeError(f"Unsupported string type: {type_}")
 
         # Remove consecutive underscores
-        # TODO: Unfortunately this clobbbers __name__
+        # TODO: Unfortunately this clobbers __name__
         # sanitized = UNDERSCORE_REGEX.sub("_",sanitized)
 
         return sanitized

instrumentation/opentelemetry-instrumentation-aio-pika/tests/consts.py

@@ -4,7 +4,7 @@
 from yarl import URL
 
 AIOPIKA_VERSION_INFO = tuple(int(v) for v in aiopika_version.split("."))
-MESSAGE_ID = "meesage_id"
+MESSAGE_ID = "message_id"
 CORRELATION_ID = "correlation_id"
 MESSAGING_SYSTEM = "rabbitmq"
 EXCHANGE_NAME = "exchange_name"

instrumentation/opentelemetry-instrumentation-asgi/tests/test_getter.py

@@ -37,17 +37,17 @@ def test_get_(self):
         self.assertEqual(
             getter.get(carrier, "Test-Key"),
             expected_val,
-            "Should be case insensitive",
+            "Should be case-insensitive",
         )
         self.assertEqual(
             getter.get(carrier, "test-key"),
             expected_val,
-            "Should be case insensitive",
+            "Should be case-insensitive",
         )
         self.assertEqual(
             getter.get(carrier, "TEST-KEY"),
             expected_val,
-            "Should be case insensitive",
+            "Should be case-insensitive",
         )
 
     def test_keys_empty_carrier(self):