Add management support.

.github/workflows/ci.yaml

@@ -75,6 +75,7 @@ jobs:
       matrix:
         features:
           - ""
+          - "--features management"
           - "--features vendored"
           - "--all-features"
     runs-on: ubuntu-20.04
@@ -103,6 +104,6 @@ jobs:
       - name: Install protoc
         run: sudo apt-get install -y protobuf-compiler=3.6.1.3-2ubuntu5
       - name: Install Rust toolchain
-        run: rustup toolchain install stable
+        run: rustup toolchain install nightly-2022-07-30
       - name: Run docs
-        run: cargo rustdoc --release -- -D warnings
+        run: cargo +nightly-2022-07-30 rustdoc --release --all-features -- --cfg docsrs

Cargo.toml

@@ -31,9 +31,12 @@ description = "Apache SkyWalking Rust Agent"
 license = "Apache-2.0"
 homepage = "https://skywalking.apache.org/"
 repository = "https://github.com/apache/skywalking-rust"
+rust-version = "1.59"
 
 [features]
+management = ["hostname", "systemstat"]
 vendored = ["protobuf-src"]
+
 mock = []  # For internal integration testing only, do not use.
 
 [dependencies]
@@ -43,10 +46,13 @@ bytes = "1.2.1"
 cfg-if = "1.0.0"
 futures-core = "0.3.21"
 futures-util = "0.3.21"
+hostname = { version = "0.3.1", optional = true }
+once_cell = "1.14.0"
 portable-atomic = { version = "0.3.13", features = ["float"] }
 prost = "0.11.0"
 prost-derive = "0.11.0"
 serde = { version = "1.0.143", features = ["derive"] }
+systemstat = { version = "0.2.0", optional = true }
 thiserror = "1.0.32"
 tokio = { version = "1.20.1", features = ["parking_lot"] }
 tonic = { version = "0.8.0", features = ["codegen"] }
@@ -73,6 +79,19 @@ required-features = ["mock"]
 name = "metrics"
 required-features = ["mock"]
 
+[[test]]
+name = "management"
+required-features = ["management"]
+
 [[example]]
 name = "simple_trace_report"
 path = "examples/simple_trace_report.rs"
+
+[[example]]
+name = "simple_management_report"
+path = "examples/simple_management_report.rs"
+required-features = ["management"]
+
+[package.metadata.docs.rs]
+rustdoc-args = ["--cfg", "docsrs"]
+all-features = true

README.md

@@ -55,6 +55,31 @@ LogRecord is the simple builder for the LogData, which is the Log format of Skyw
 - **Gauge** API represents a single numerical value.
 - **Histogram** API represents a summary sample observations with customized buckets.
 
+## Management
+
+Reporting the extra information of the instance.
+
+### Report instance properties
+
+The method `insert_os_info` of `skywalking::management::instance::Properties` will insert the predefined os info.
+In addition, you can use `insert`, `update`, and `remove` to customize your instance information.
+
+The predefined os info:
+
+| Key                      | Value                          |
+| ------------------------ | ------------------------------ |
+| hostname                 | The hostname of os.            |
+| ipv4 (probably multiple) | The ipv4 addresses of network. |
+| language                 | rust                           |
+| OS Name                  | Linux / Windows / Mac OS X     |
+| Process No.              | The ID of Process.             |
+
+### Keep alive
+
+Keep the instance alive in the backend analysis.
+Only recommend to do separate keepAlive report when no trace and metrics needs to be reported.
+Otherwise, it is duplicated.
+
 # Example
 
 ```rust, no_run

build.rs

@@ -23,11 +23,13 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
         .type_attribute(".", "#[derive(serde::Serialize, serde::Deserialize)]")
         .compile(
             &[
-                "./skywalking-data-collect-protocol/language-agent/Tracing.proto",
                 "./skywalking-data-collect-protocol/language-agent/Meter.proto",
+                "./skywalking-data-collect-protocol/language-agent/Tracing.proto",
                 "./skywalking-data-collect-protocol/logging/Logging.proto",
+                "./skywalking-data-collect-protocol/management/Management.proto",
             ],
             &["./skywalking-data-collect-protocol"],
         )?;
+
     Ok(())
 }

examples/simple_management_report.rs

@@ -0,0 +1,54 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+//
+
+use skywalking::{
+    management::{instance::Properties, manager::Manager},
+    reporter::grpc::GrpcReporter,
+};
+use std::{error::Error, time::Duration};
+use tokio::signal;
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn Error>> {
+    // Connect to skywalking oap server.
+    let reporter = GrpcReporter::connect("http://0.0.0.0:11800").await?;
+
+    // Spawn the reporting in background, with listening the graceful shutdown
+    // signal.
+    let handle = reporter
+        .reporting()
+        .await
+        .with_graceful_shutdown(async move {
+            signal::ctrl_c().await.expect("failed to listen for event");
+        })
+        .spawn();
+
+    let manager = Manager::new("service", "instance", reporter);
+
+    // Report instance properties.
+    let mut props = Properties::default();
+    props.insert_os_info();
+    manager.report_properties(props);
+
+    // Keep alive
+    manager.keep_alive(Duration::from_secs(10));
+
+    handle.await?;
+
+    Ok(())
+}

rust-toolchain.toml

@@ -16,5 +16,5 @@
 # under the License.
 #
 [toolchain]
-channel = "1.57.0"
+channel = "1.59.0"
 components = ["rustfmt", "clippy"]

src/lib.rs

@@ -16,10 +16,14 @@
 #![warn(rust_2018_idioms)]
 #![warn(clippy::dbg_macro, clippy::print_stdout)]
 #![doc = include_str!("../README.md")]
+#![cfg_attr(docsrs, feature(doc_cfg))]
 
 pub mod common;
 pub(crate) mod error;
 pub mod logging;
+#[cfg(feature = "management")]
+#[cfg_attr(docsrs, doc(cfg(feature = "management")))]
+pub mod management;
 pub mod metrics;
 pub mod reporter;
 pub mod skywalking_proto;

src/logging/logger.rs

@@ -52,14 +52,14 @@ pub struct Logger {
 impl Logger {
     /// New with service info and reporter.
     pub fn new(
-        service_name: impl ToString,
-        instance_name: impl ToString,
+        service_name: impl Into<String>,
+        instance_name: impl Into<String>,
         reporter: impl Report + Send + Sync + 'static,
     ) -> Self {
         Self {
             inner: Arc::new(Inner {
-                service_name: service_name.to_string(),
-                instance_name: instance_name.to_string(),
+                service_name: service_name.into(),
+                instance_name: instance_name.into(),
                 reporter: Box::new(reporter),
             }),
         }
@@ -78,6 +78,6 @@ impl Logger {
             self.service_name().to_owned(),
             self.instance_name().to_owned(),
         );
-        self.inner.reporter.report(CollectItem::Log(data));
+        self.inner.reporter.report(CollectItem::Log(Box::new(data)));
     }
 }

src/logging/record.rs

@@ -68,26 +68,24 @@ impl LogRecord {
     }
 
     #[inline]
-    pub fn endpoint(mut self, endpoint: impl ToString) -> Self {
-        self.endpoint = endpoint.to_string();
+    pub fn endpoint(mut self, endpoint: impl Into<String>) -> Self {
+        self.endpoint = endpoint.into();
         self
     }
 
-    pub fn add_tag(mut self, key: impl ToString, value: impl ToString) -> Self {
-        self.tags.push((key.to_string(), value.to_string()));
+    pub fn add_tag(mut self, key: impl Into<String>, value: impl Into<String>) -> Self {
+        self.tags.push((key.into(), value.into()));
         self
     }
 
     pub fn add_tags<K, V, I>(mut self, tags: I) -> Self
     where
-        K: ToString,
-        V: ToString,
+        K: Into<String>,
+        V: Into<String>,
         I: IntoIterator<Item = (K, V)>,
     {
-        self.tags.extend(
-            tags.into_iter()
-                .map(|(k, v)| (k.to_string(), v.to_string())),
-        );
+        self.tags
+            .extend(tags.into_iter().map(|(k, v)| (k.into(), v.into())));
         self
     }
 
@@ -107,8 +105,8 @@ impl LogRecord {
         self
     }
 
-    pub fn content(mut self, content: impl ToString) -> Self {
-        self.content = content.to_string();
+    pub fn content(mut self, content: impl Into<String>) -> Self {
+        self.content = content.into();
         self
     }