wu-sheng commented on a change in pull request #5:
URL: https://github.com/apache/skywalking-rust/pull/5#discussion_r771828940
##########
File path: README.md
##########
@@ -30,60 +30,24 @@ Tag and Log are similar attributes of the span.
TracingContext is the context of the tracing process. Span should only be
created through context, and be archived into the
context after the span finished.
-## Injectable
-Injectable is used(optional) when the exit span creates. This Injectable
received the notification from tracing context,
-including the key and value for tracing context across process propagation.
Typically, Injectable implementation would
-manipulate the RPC header/metadata to make the key/value sent to the server
side.
-
-## Extractable
-Extractable is used(optional) when the entry span creates. The Extractable
fetches the value of the given key from the propagated
-context. Typically, Extractable implementation would read the RPC
header/metadata, which sent from the client side.
-
-# APIs
-## High-Level APIs
-High level APIs are targeting convenient usages. These APIs use the
ThreadLocal to propagate the context, so users could
-create span at any moment, and the context will finish automatically once the
first created span of this thread stopped.
+# Example
```rust
-ContextManager::tracing_entry("op1", Some(&injector), |mut span| {
- // Use span freely in this closure
- // Span's start/end time is set automatically with this closure
start/end(s).
- span.tag(Tag::new(String::from("tag1"), String::from("value1")));
-
- ContextManager::tracing_exit("op2", "127.0.0.1:8080", Some(&extractor),
|mut span| {
- span.set_component_id(33);
- });
-
- ContextManager::tracing_local("op3", |mut span| {});
-});
-```
-
-## Low-Level Core APIs
-Tracing core APIs are 100% manual control tracing APIs. Users could use them
to trace any process by following SkyWalking
-core concepts.
-
-Low Level APIs request users to create and hold the context and span by the
codes manually.
-
-```rust
-let mut context = TracingContext::new(reporter.service_instance_id()).unwrap();
-let span1 = context.create_entry_span("op1", None, Some(&dyn injector));
-{
- assert_eq!(span1.span_id(), 0);
- let mut span2 = context.create_local_span("op2", Some(&span1));
- span2.tag(Tag::new(String::from("tag1"), String::from("value1")));
+use skywalking_rust::context::trace_context::TracingContext;
+use skywalking_rust::reporter::grpc::Reporter;
+use tokio;
+
+#[tokio::main]
+async fn main() {
+ let tx = Reporter::start("http://0.0.0.0:11800".to_string()).await;
+ let mut context = TracingContext::default("service", "instance");
{
- assert_eq!(span2.span_id(), 1);
- let mut span3 = context.create_exit_span("op3", Some(&span2),
"127.0.0.1:8080", Some(&dyn extractor));
- assert_eq!(span3.span_id(), 2);
-
- context.finish_span(span3);
+ let span = context.create_entry_span("op1").unwrap();
Review comment:
Should we have more API doc about spans, tags and logs?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
