-
Notifications
You must be signed in to change notification settings - Fork 10
Add missing documentation bundles #32
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.
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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # ``GRPCInteropTests`` | ||
|
|
||
| This module contains implementations for gRPC interoperability tests. | ||
|
|
||
| ## Overview | ||
| You can find more information on gRPC interoperability tests by looking at [gRPC's Interoperability Test Case Description](https://github.com/grpc/grpc/blob/master/doc/interop-test-descriptions.md). | ||
56 changes: 56 additions & 0 deletions
56
Sources/GRPCOTelTracingInterceptors/Documentation.docc/Documentation.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # ``GRPCOTelTracingInterceptors`` | ||
|
|
||
| This module contains client and server tracing interceptors adhering to OpenTelemetry's | ||
| recommendations on tracing. | ||
|
|
||
| ## Overview | ||
|
|
||
| You can read more on this topic at [OpenTelemetry's documentation](https://opentelemetry.io/docs). | ||
| Some relevant pages listing which attributes and events you can expect on your spans include: | ||
| - [RPC Spans](https://opentelemetry.io/docs/specs/semconv/rpc/rpc-spans) | ||
| - [gRPC conventions](https://opentelemetry.io/docs/specs/semconv/rpc/grpc) | ||
|
|
||
| You can set up a client interceptor like so during your bootstrapping phase: | ||
|
|
||
| ```swift | ||
| // Create the client interceptor | ||
| let interceptor = ClientOTelTracingInterceptor( | ||
| serverHostname: "someserver.com", | ||
| networkTransportMethod: "tcp" | ||
| ) | ||
|
|
||
| // Add it as an interceptor when creating your client | ||
| let client = GRPCClient( | ||
| transport: someTransport, | ||
gjcairo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| interceptors: [interceptor] | ||
| ) | ||
|
|
||
| // Finally run your client | ||
| try await client.runConnections() | ||
| ``` | ||
|
|
||
| You can similarly add the server interceptor to your server like this: | ||
|
|
||
| ```swift | ||
| // Create the server interceptor | ||
| let interceptor = ServerOTelTracingInterceptor( | ||
| serverHostname: "someserver.com", | ||
| networkTransportMethod: "tcp" | ||
| ) | ||
|
|
||
| // Add it as an interceptor when creating your server | ||
| let server = GRPCServer( | ||
| transport: inProcess.server, | ||
gjcairo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| services: [TestService()], | ||
| interceptors: interceptor | ||
| ) | ||
|
|
||
| // Finally run your server | ||
| try await server.serve() | ||
| ``` | ||
|
|
||
| For more information, look at the documentation for: | ||
| - ``GRPCOTelTracingInterceptors/ClientOTelTracingInterceptor``, | ||
| - ``GRPCOTelTracingInterceptors/ServerOTelTracingInterceptor``, | ||
| - [Client Interceptors](https://swiftpackageindex.com/grpc/grpc-swift/documentation/grpccore/clientinterceptor), | ||
| - [Server Interceptors](https://swiftpackageindex.com/grpc/grpc-swift/documentation/grpccore/serverinterceptor) | ||
8 changes: 8 additions & 0 deletions
8
Sources/GRPCReflectionService/Documentation.docc/Documentation.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # ``GRPCReflectionService`` | ||
|
|
||
| This module contains an implementation of the gRPC Reflection service | ||
| ("grpc.reflection.v1.ServerReflection"). | ||
|
|
||
| ## Overview | ||
|
|
||
| The reflection service is a regular gRPC service providing information about other services. |
8 changes: 8 additions & 0 deletions
8
Sources/GRPCServiceLifecycle/Documentation.docc/Documentation.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # ``GRPCServiceLifecycle`` | ||
|
|
||
| This module conforms `GRPCClient` and `GRPCServer` to the `Service` protocol of `SwiftServiceLifecycle`, | ||
| to allow for easy composition. | ||
|
|
||
| ## Overview | ||
|
|
||
| For more information on `SwiftServiceLifecycle`, [see its documentation](https://swiftpackageindex.com/swift-server/swift-service-lifecycle/documentation/servicelifecycle). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.