Merge pull request #21 from instana/yanweili

Update package readme

packages/@instana-integration/go/README.md

@@ -10,7 +10,7 @@ Below are the dashboards that are currently supported by this integration packag
 |----------------------------|-----------------------|
 | Go Runtime Metrics   | Instana custom dashboard that displays runtime metrics for Go application |
 
-### Go Runtime Metrics
+## Go Runtime Metrics
 
 ### Semantic Conventions for Go Runtime Metrics
 
@@ -44,3 +44,28 @@ Below are the resource attributes that are currently supported by this integrati
 |----------------------------|-------|------------------------|
 | service.name               | string  | This attribute is used to describe the entity name.    |
 | service.instance.id        | string  | This attribute is used to describe the entity ID of the current object.  |
+
+### Installation and Usage
+
+With [Instana CLI for integration package management](https://github.com/instana/observability-as-code?tab=readme-ov-file#instana-cli-for-integration-package-management), you can manage the lifecycle of this package such as downloading the package and importing it into Instana.
+
+Downloading the package:
+
+```shell
+$ stanctl-integration download --package @instana-integration/go
+```
+
+Importing the package into Instana:
+
+```shell
+$ stanctl-integration import --package @instana-integration/go \
+  --server $INSTANA_SERVER \
+  --token $API_TOKEN \
+  --set servicename=$SERVICE_NAME \
+  --set serviceinstanceid=$SERVICE_INSTANCE_ID
+```
+
+- INSTANA_SERVER: This is the base URL of an Instana tenant unit, e.g. https://test-example.instana.io, which is used by the CLI to communicate with Instana server for package lifecycle management.
+- API_TOKEN: Requests against the Instana API require valid API tokens. The API token can be generated via the Instana user interface. For more information, please refers to [Instana documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-instana-rest-api#usage-of-api-token).
+- SERVICE_NAME: Logical name of the service.
+- SERVICE_INSTANCE_ID: The string ID of the service instance. The ID helps to distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled service).

packages/@instana-integration/go/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@instana-integration/go",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "The integration package is used to support Go monitoring. Once you import this package into your Instana environment, you will be able to monitor Go runtime and the applications on various aspects by checking the dashboards, alerts, etc. included in this integration package.",
   "author": "IBM",
   "license": "MIT",
   "scripts": {},
   "keywords": [
     "ibm",
     "instana",
-    "customer dashboard",
+    "custom dashboard",
     "opentelemetry",
     "go",
     "monitoring"

packages/@instana-integration/nodejs/README.md

@@ -10,7 +10,7 @@ Below are the dashboards that are currently supported by this integration packag
 |----------------------------|-----------------------|
 | Node.js Runtime Metrics   | Instana custom dashboard that displays runtime metrics for Node.js application |
 
-### Node.js Runtime Metrics
+## Node.js Runtime Metrics
 
 ### Semantic Conventions for  Node.js Runtime Metrics
 
@@ -55,3 +55,28 @@ Below are the resource attributes that are currently supported by this integrati
 |----------------------------|-------|------------------------|
 | service.name               | string  | This attribute is used to describe the entity name.    |
 | service.instance.id        | string  | This attribute is used to describe the entity ID of the current object.  |
+
+### Installation and Usage
+
+With [Instana CLI for integration package management](https://github.com/instana/observability-as-code?tab=readme-ov-file#instana-cli-for-integration-package-management), you can manage the lifecycle of this package such as downloading the package and importing it into Instana.
+
+Downloading the package:
+
+```shell
+$ stanctl-integration download --package @instana-integration/nodejs
+```
+
+Importing the package into Instana:
+
+```shell
+$ stanctl-integration import --package @instana-integration/nodejs \
+  --server $INSTANA_SERVER \
+  --token $API_TOKEN \
+  --set servicename=$SERVICE_NAME \
+  --set serviceinstanceid=$SERVICE_INSTANCE_ID
+```
+
+- INSTANA_SERVER: This is the base URL of a tenant unit, e.g. https://test-example.instana.io. This is the same URL that is used to access the Instana user interface.
+- API_TOKEN: Requests against the Instana API require valid API tokens. The API token can be generated via the Instana user interface. For more information, please refers to [Instana documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-instana-rest-api#usage-of-api-token).
+- SERVICE_NAME: Logical name of the service.
+- SERVICE_INSTANCE_ID: The string ID of the service instance. The ID helps to distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled service).

packages/@instana-integration/nodejs/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@instana-integration/nodejs",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "The integration package is used to support Node.js monitoring. Once you import this package into your Instana environment, you will be able to monitor Node.js runtime and the applications on various aspects by checking the dashboards, alerts, etc. included in this integration package.",
   "author": "IBM",
   "license": "MIT",
   "scripts": {},
   "keywords": [
     "ibm",
     "instana",
-    "customer dashboard",
+    "custom dashboard",
     "opentelemetry",
     "nodejs",
     "monitoring"

packages/@instana-integration/opentelemetry-demo/README.md

@@ -11,3 +11,33 @@ Below are the dashboards that are currently supported by this integration packag
 | OpenTelemetry Demo - Go Runtime Metrics   | checkout | Go          |
 | OpenTelemetry Demo - Node.js Runtime Metrics   | payment | Node.js   |
 
+### Resource Attributes for Node.js Application
+
+Below are the resource attributes that are currently supported by this integration package.
+
+| Attribute Key              | Type |  Description           |
+|----------------------------|-------|------------------------|
+| service.instance.id        | string  | This attribute is used to describe the entity ID of the current object.  |
+
+## Installation and Usage
+
+With [Instana CLI for integration package management](https://github.com/instana/observability-as-code?tab=readme-ov-file#instana-cli-for-integration-package-management), you can manage the lifecycle of this package such as downloading the package and importing it into Instana.
+
+Downloading the package:
+
+```shell
+$ stanctl-integration download --package @instana-integration/opentelemetry-demo
+```
+
+Importing the package into Instana:
+
+```shell
+$ stanctl-integration import --package @instana-integration/opentelemetry-demo \
+  --server $INSTANA_SERVER \
+  --token $API_TOKEN \
+  --set serviceinstanceid=$SERVICE_INSTANCE_ID
+```
+
+- INSTANA_SERVER: This is the base URL of a tenant unit, e.g. https://test-example.instana.io. This is the same URL that is used to access the Instana user interface.
+- API_TOKEN: Requests against the Instana API require valid API tokens. The API token can be generated via the Instana user interface. For more information, please refers to [Instana documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=apis-instana-rest-api#usage-of-api-token).
+- SERVICE_INSTANCE_ID: The string ID of the service instance. The ID helps to distinguish instances of the same service that exist at the same time (e.g. instances of a horizontally scaled service).

packages/@instana-integration/opentelemetry-demo/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instana-integration/opentelemetry-demo",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "The instana integration package used to demonstrate the monitoring of the OpenTelemetry demo application.",
   "author": "IBM",
   "license": "MIT",
@@ -9,7 +9,7 @@
     "ibm",
     "instana",
     "opentelemetry",
-    "customer dashboard",
+    "custom dashboard",
     "demo"
   ]
 }