Skip to content

Fix typos #45238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix typos #45238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0d78bc
Fix typos
omahs May 7, 2025
dc334cf
Update CONTRIBUTING.md
FabianMeiswinkel May 7, 2025
eea2564
fix typos
omahs May 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/deprecation_process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This page can be linked using: [aka.ms/azsdk/java/deprecation-process](https://a
This page describes how to mark a package deprecated on Maven. You likely need to read this if you are a package owner
and need to explain to your customers they shouldn't use the package you used to release anymore.

The over idea is that Maven does not support an official deprecation logic. We concluded that the best way was:
The overall idea is that Maven does not support an official deprecation logic. We concluded that the best way was:

- Add a disclaimer on the main README file and the POM description and guide to the migration guide to the new package
as necessary.
Expand Down
2 changes: 1 addition & 1 deletion doc/dev/CredScan-Process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This guide describes how package owners can monitor their package's Credential S
any warnings.

General information about CredScan can be found in the overview documentation at [aka.ms/credscan][credscan_doc]. The
Azure SDK's motivation and methodology for running CredScan is documented [here][devops_doc].
Azure SDK's motivation and methodology for running CredScan are documented [here][devops_doc].

## Table of Contents

Expand Down
2 changes: 1 addition & 1 deletion eng/bomgenerator/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Arguments to run the tool in this mode.
3. InputDependencies file to override the inputs from the version_client.txt. This is an optional file.

-outputDir=<location_of_outputput_directory>
This generates the followibg files in the location.
This generates the following files in the location.
1. Report log.
2. Newly created BOM file

Expand Down
2 changes: 1 addition & 1 deletion sdk/communication/azure-communication-callautomation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ If timeout was not set when calling "waitForEventProcessorAsync", the default ti

## Troubleshooting

If you recieve a CommunicationErrorException with the messagae: "Action is invalid when call is not in Established state." This usually means the call has ended. This can occur if the participants all leave
If you receive a CommunicationErrorException with the message: "Action is invalid when call is not in Established state." This usually means the call has ended. This can occur if the participants all leave
the call, or participants did not accept the call before the call timed out.

If you fail to start a call because of an HMAC validation error, be sure your access key is correct, and
Expand Down
2 changes: 1 addition & 1 deletion sdk/communication/azure-communication-callingserver/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ To be determined.

## Troubleshooting

If you recieve a CommunicationErrorException with the messagae: "Action is invalid when call is not in Established state." This usually means the call has ended. This can occur if the participants all leave
If you receive a CommunicationErrorException with the message: "Action is invalid when call is not in Established state." This usually means the call has ended. This can occur if the participants all leave
the call, or participants did not accept the call before the call timed out.

If you fail to start a call because of an HMAC validation error, be sure your access key is correct, and
Expand Down
16 changes: 8 additions & 8 deletions sdk/cosmos/azure-cosmos/docs/Metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ this.client = new CosmosClientBuilder()
.buildClient();
```

A sample for a `MeterRegistry` simply logging to the Console can be create like this:
A sample for a `MeterRegistry` simply logging to the Console can be created like this:

```java
private static MeterRegistry createConsoleLoggingMeterRegistry() {
Expand Down Expand Up @@ -78,7 +78,7 @@ The micrometer.io documentation has a list with samples on how to create a `Mete
|--------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --------------------------- |
| `Container` | `accountName / databaseName / containerName` | The fully qualified container name | operations + requests |
| `Operation` | `Document / ReadFeed` or `Document / queryItems / SomeLogicalQueryIdentifier` | The operation type and for queries with optional logical operation identifier as suffix | operations + requests |
| `OperationStatusCode` | `200` or `429` etc. | The status code of the operation reported to the app/svc (could indicate sucess `200` even after hitting errors and retyring successfully) | operations + requests |
| `OperationStatusCode` | `200` or `429` etc. | The status code of the operation reported to the app/svc (could indicate success `200` even after hitting errors and retrying successfully) | operations + requests |
| `ClientCorrelationId` | `MyClientUsingAADAuth` | An identifier of the Cosmos client instance - can be specified via the `CosmosClientBuilder. clientTelemetryConfig(). clientCorrelationId(String)` method or gets auto-generated | operations + requests |
| `ConsistencyLevel` | `Eventual`, `ConsistentPrefix`, `BoundedStaleness`, `Strong` or `Session` | The consistency level used for the operation <br /><br />**Disabled by default** | operations + requests |
| `PartitionKeyRangeId` | `1` | The partition key range id - an identifier for the physical shard/partition in the backend. This can be helpful to identify whether load is skewed across physical partitions.<br /><br />**Disabled by default** | operations + requests |
Expand All @@ -90,7 +90,7 @@ The micrometer.io documentation has a list with samples on how to create a `Mete
| `IsForceRefresh` | `True` or `False` | A flag indicating whether a forced address refresh is requested<br /><br />**Disabled by default** | address refresh requests |
| `IsForceCollectionRoutingMapRefresh` | `True` or `False` | A flag indicating whether a forced refresh of partition and collection metadata is requested<br /><br />**Disabled by default** | address refresh requests |
| `PartitionId` | `512fe816-24fa-4fbb-bbb1-587d2ce19851` | The unique identifier of a physical partition - can be used in addition aor as alternative for `ServiceAddress`. <br /><br />**Disabled by default** | requests (direct TCP/rntbd) |
| `ReplicaId` | `133038444008943156p` | The replica identifier with a suffix - `p` (primary/write) or `s` (seocndary/read-only) - indicating whther it is a read-only replica or not. This tag can be used in addition aor as alternative for `ServiceAddress`. <br /><br />**Disabled by default** | requests (direct TCP/rntbd) |
| `ReplicaId` | `133038444008943156p` | The replica identifier with a suffix - `p` (primary/write) or `s` (secondary/read-only) - indicating whether it is a read-only replica or not. This tag can be used in addition or as alternative for `ServiceAddress`. <br /><br />**Disabled by default** | requests (direct TCP/rntbd) |



Expand All @@ -107,8 +107,8 @@ The micrometer.io documentation has a list with samples on how to create a `Mete
| cosmos.client.op.calls | # calls | None | Number of operation calls |
| cosmos.client.op.RUs | RU (request unit) | 95th, 99th + histogram | Total request units per operation (sum of RUs for all requested needed when processing an operation) |
| cosmos.client.op.latency | duration (MeterRegistry determines default - usually ms ) | 95th, 99th + histogram | Total end-to-end duration of the operation |
| cosmos.client.op.maxItemCount | # | None | For feed operations (query, readAll, readMany, change feed) and batch operations this meter capture the requested maxItemCount per page/request |
| cosmos.client.op.actualItemCount | # | None | For feed operations (query, readAll, readMany, change feed) batch operations this meter capture the actual item count in responses from the service |
| cosmos.client.op.maxItemCount | # | None | For feed operations (query, readAll, readMany, change feed) and batch operations this meter captures the requested maxItemCount per page/request |
| cosmos.client.op.actualItemCount | # | None | For feed operations (query, readAll, readMany, change feed) batch operations this meter captures the actual item count in responses from the service |
| cosmos.client.op.regionscontacted | # regions | None | Number of regions contacted when executing an operation |

### Metrics for requests to the Cosmos DB Gateway endpoint
Expand All @@ -118,7 +118,7 @@ The micrometer.io documentation has a list with samples on how to create a `Mete
| cosmos.client.req.gw.requests | # requests | None | Number of requests |
| cosmos.client.req.gw.latency | duration | 95th, 99th + histogram | End-to-end duration spent for processing the request |
| cosmos.client.req.gw.timeline.xxx | duration | 95th, 99th + histogram | Duration spent in different stages of the request pipeline |
| cosmos.client.req.gw.actualItemCount | # | None | For feed operations (query, readAll, readMany, change feed) and batch operations this meter capture the actual item count in responses from the service |
| cosmos.client.req.gw.actualItemCount | # | None | For feed operations (query, readAll, readMany, change feed) and batch operations this meter captures the actual item count in responses from the service |
| cosmos.client.req.reqPayloadSize | bytes | None | The request payload size in bytes |
| cosmos.client.req.rspPayloadSize | bytes | None | The response payload size in bytes |
| cosmos.client.req.gw.bulkOpCountPerEvaluation | # | None | Batch operation count (executed as part of bulk operation) per batch size evaluation cycle |
Expand All @@ -134,7 +134,7 @@ The micrometer.io documentation has a list with samples on how to create a `Mete
| cosmos.client.req.rntbd.latency | duration | 95th, 99th + histogram | End-to-end duration spent for processing the request |
| cosmos.client.req.rntbd.backendLatency | duration | 95th, 99th + histogram | Duration spent for processing the request in the Cosmos DB service endpoint (self-attested by backend) |
| cosmos.client.req.rntbd.timeline.xxx | duration | 95th, 99th + histogram | Duration spent in different stages of the request pipeline |
| cosmos.client.req.rntbd.actualItemCount | # | None | For feed operations (query, readAll, readMany, change feed) and batch operations this meter capture the actual item count in responses from the service |
| cosmos.client.req.rntbd.actualItemCount | # | None | For feed operations (query, readAll, readMany, change feed) and batch operations this meter captures the actual item count in responses from the service |
| cosmos.client.req.reqPayloadSize | bytes | None | The request payload size in bytes |
| cosmos.client.req.rspPayloadSize | bytes | None | The response payload size in bytes |
| cosmos.client.req.rntbd.addressResolution.requests | # requests | None | Number of physical address resolution requests of replica for a certain partition |
Expand Down Expand Up @@ -176,7 +176,7 @@ The micrometer.io documentation has a list with samples on how to create a `Mete

Metrics are available for other stages in the request pipeline as well - but the following stages will be of special interest for monitoring applications:

- channelAcquisitionStarted: Higher values indicate that no channel (TCP connection) is available and a new one needs to be created - either because there is no open connection for the requested replica or because the number of concurrent requests is so high that another connection is needeed
- channelAcquisitionStarted: Higher values indicate that no channel (TCP connection) is available and a new one needs to be created - either because there is no open connection for the requested replica or because the number of concurrent requests is so high that another connection is needed
- transitTime: This is the duration between first byte sent and last byte received - so the time spent in the backend for processing the request + the network turnaround-time. High value with high variance to the backend-reported latency usually indicate either network problems or some resource constraint on the client (or network component like SNAT ports)
- pipelined: is the time the requests waits because too many concurrent requests are being processed on a channel (TCP connection). Constantly high values here would indicate that the capacity of the application/service isn't sufficient and would need to be scaled-out.
- The other pipeline stages are not expected to have regularly high values - any high values usually would indicate either some thread-pool issue on the client or client overload. Best way to double check usually is looking whether high values happen on only single (few) client machines or all of them - and what the CPU utilization (max) is at the time in question.
Expand Down
2 changes: 1 addition & 1 deletion sdk/cosmos/azure-cosmos/docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Set target bytecode version for the project azure-cosmos in IntelliJ Preferences

Setup Azure Cosmos DB Emulator by following [this instruction](https://docs.microsoft.com/azure/cosmos-db/local-emulator). Then please export the emulator's SSL certificates and install them in the JVM trust stores on your development machine following [this instruction](https://learn.microsoft.com/azure/cosmos-db/local-emulator-export-ssl-certificates).

For running the SDK unit tests use follogwing start options for the emulator:
For running the SDK unit tests use following start options for the emulator:
PS C:\Program Files\Azure Cosmos DB Emulator> .\CosmosDB.Emulator.exe /enablepreview /EnableSqlComputeEndpoint /disableratelimiting /partitioncount=50 /consistency=Strong

For installing the keys on windows following power shell script (running as administrator) can be used:
Expand Down
Loading