Merge from master

Author: preet-dev

.gitignore

@@ -3,4 +3,5 @@
 .DS_Store
 build
 /logs
-gradle/wrapper/gradle-wrapper.jar
+bin
+gradle/wrapper/gradle-wrapper.jar

README.md

@@ -26,39 +26,45 @@ This tools can be added to your code as a dependency or executed from the comman
 
 ## Quickstart
 
-For a quick start with a basic setup you can download the [latest fat-jar](https://github.com/cisco-open/test-telemetry-generator/releases/download/latest/test-telemetry-generator-otel-proto-0.18.0-fatjar.jar) and [example definitions](./example-definitions/) and put them all into one directory.
+For a quick start with a basic setup you can download the [latest fat-jar](https://github.com/cisco-open/test-telemetry-generator/releases/download/latest/test-telemetry-generator-otel-proto-0.18.0-fatjar.jar) and [example definitions](./example-definitions/) and put them all into one directory. We recommend that you start with the [simple example definitions](./example-definitions/simple/).
 
 You can do all of that in the command line using [curl](https://curl.se/) like the following:
 
 ```shell
 mkdir my-test-telemetry
 cd my-test-telemetry
 curl -O -L https://github.com/cisco-open/test-telemetry-generator/releases/latest/download/test-telemetry-generator-otel-proto-0.18.0-fatjar.jar
-curl -O https://raw.githubusercontent.com/cisco-open/test-telemetry-generator/master/example-definitions/entity-definition.yaml
-curl -O https://raw.githubusercontent.com/cisco-open/test-telemetry-generator/master/example-definitions/trace-definition.yaml
+curl -O https://raw.githubusercontent.com/cisco-open/test-telemetry-generator/master/example-definitions/simple/resource-definition.yaml
+curl -O https://raw.githubusercontent.com/cisco-open/test-telemetry-generator/master/example-definitions/simple/trace-definition.yaml
 curl -O https://raw.githubusercontent.com/cisco-open/test-telemetry-generator/master/example-definitions/cli-target-rest.yaml
 ```
 
 Your `my-test-telemetry` directory should now contain the following files:
 
 ```shell
 $ ls
-cli-target-rest.yaml  entity-definition.yaml  test-telemetry-generator-otel-proto-0.18.0-fatjar.jar  trace-definition.yaml
+cli-target-rest.yaml  resource-definition.yaml  test-telemetry-generator-otel-proto-0.18.0-fatjar.jar  trace-definition.yaml
 ```
 
 Next, open the `cli-target-rest.yml` with an editor of your choice and set the `restURL` to your OTLP HTTP endpoint. For example, if you use an [OpenTelemetry
 Collector](https://opentelemetry.io/docs/collector/) running on `localhost` with an `otlp` receiver listening on port `4318`, update your target config to look like the following:
 
 ```yaml
-username: "ignored"
-password: "ignored"
-restURL: "http://localhost:4318/v1/traces"
+authMode: "none"
+# Set authmode to 'basic' and uncomment username & password if you need authentication
+# username: "your-username"
+# password: "your-password"
+restURL:
+  baseURL: "http://localhost:4318"
+  metricsPath: "/v1/metrics"
+  logsPath: "/v1/logs"
+  tracesPath: "/v1/traces"
 ```
 
 Finally, start the test-telemetry-generator:
 
 ```shell
-java -jar test-telemetry-generator-otel-proto-0.18.0-fatjar.jar -e entity-definition.yaml -s trace-definition.yaml -t cli-target-rest.yaml
+java -jar test-telemetry-generator-otel-proto-0.18.0-fatjar.jar -r resource-definition.yaml -s trace-definition.yaml -t cli-target-rest.yaml
 ```
 
 If all goes well, you should see test-telemetry-generator printing out some logs for you:

build.gradle

@@ -26,7 +26,7 @@ dependencies {
     api group: 'org.projectlombok', name: 'lombok', version: '1.18.20'
     api group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-yaml', version: '2.13.2'
     api group: 'io.opentelemetry.proto', name: 'opentelemetry-proto', version: '0.18.0-alpha'
-    api group: 'io.opentelemetry', name: 'opentelemetry-sdk-trace', version: '1.12.0'
+    api group: 'io.opentelemetry', name: 'opentelemetry-sdk-trace', version: '1.17.0'
     api group: 'com.google.guava', name: 'guava', version: 'r05'
     api group: 'org.apache.commons', name: 'commons-collections4', version: '4.4'
     api group: 'org.apache.commons', name: 'commons-lang3', version: '3.12.0'

example-definitions/README.md

@@ -0,0 +1,16 @@
+# Example Definitions
+
+In the subfolders you will find different sets of example definitions you can use
+with the test-telemetry-generator:
+
+| Folder | Description |
+|--------|-------------|
+| [simple](./simple) | A very simple example, start here to learn how to use test-telemetry-generator |
+| [demo](./demo) | An example that simulates (parts of) the [OpenTelemetry demo](https://github.com/open-telemetry/opentelemetry-demo) |
+| [json](./json) | An example in JSON format |
+| [qa](./qa) | A complex example that is used for running quality assurance tests against an OTLP backend |
+
+
+Note that the target configuration does not change across examples, so you can
+use the same [grpc](./cli-target-grpc.yaml) or [rest](./cli-target-rest.yaml)
+configuration in all cases.

example-definitions/cli-target-grpc.yaml

@@ -1,5 +1,6 @@
-authMode: "basic"
-username: "your-username"
-password: "your-password"
-grpchost: "target-gRPC-host"
-grpcport: "target-gRPC-port"
+authMode: none
+# Set authmode to 'basic' and uncomment username & password if you need authentication
+# username: "username"
+# password: "password"
+grpchost: "localhost"
+grpcport: "4317"

example-definitions/cli-target-rest.yaml

@@ -1,4 +1,9 @@
-authMode: "basic"
-username: "your-username"
-password: "your-password"
-restURL: "target-rest-URL"
+authMode: "none"
+# Set authmode to 'basic' and uncomment username & password if you need authentication
+# username: "your-username"
+# password: "your-password"
+restURL:
+  baseURL: "http://localhost:4318"
+  metricsPath: "/v1/metrics"
+  logsPath: "/v1/logs"
+  tracesPath: "/v1/traces"

example-definitions/demo/resource-definition.yaml

@@ -0,0 +1,97 @@
+#
+# Copyright 2022 AppDynamics Inc.
+#
+# Licensed 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.
+#
+
+resources:
+  - name: frontend
+    count: 3
+    childrenDistribution:
+      frontend_instance: distribution(1, 1, 1)
+    attributes:
+      service.name: '"frontend"'
+      service.namespace: '"opentelemetry-demo"'
+  - name: frontend_instance
+    count: 6
+    attributes:
+      telemetry.sdk.name: '"opentelemetry"'
+      telemetry.sdk.language: '"nodejs"'
+      telemetry.sdk.version: counter('1.2.')
+    attributeOperations:
+      - 'copyFromParent("container", "container.name")'
+      - 'copyFromParent("container", "container.id")'
+      - 'copyFromParent("frontend", "service.name")'
+      - 'copyFromParent("frontend", "telemetry.sdk.language")'
+      - 'copyFromParent("frontend", "service.namespace")'
+      - 'modifyFromParent("frontend", "service.name", "service.instance_id", "counter(\"-\")")'
+  - name: checkout
+    count: 3
+    childrenDistribution:
+      checkout_instance: distribution(1, 1, 1)
+    attributes:
+      service.name: '"checkout"'
+      service.namespace: '"opentelemetry-demo"'
+  - name: checkout_instance
+    count: 6
+    attributes:
+      telemetry.sdk.name: '"opentelemetry"'
+      telemetry.sdk.language: '"go"'
+      telemetry.sdk.version: counter('1.3.')
+    attributeOperations:
+      - 'copyFromParent("container", "container.name")'
+      - 'copyFromParent("container", "container.id")'
+      - 'copyFromParent("checkout", "service.name")'
+      - 'copyFromParent("checkout", "telemetry.sdk.language")'
+      - 'copyFromParent("checkout", "service.namespace")'
+      - 'modifyFromParent("checkout", "service.name", "service.instance_id", "counter(\"-\")")'
+  - name: email
+    count: 3
+    childrenDistribution:
+      email_instance: distribution(1, 1, 1)
+    attributes:
+      service.name: '"email"'
+      service.namespace: '"opentelemetry-demo"'
+  - name: email_instance
+    count: 6
+    attributes:
+      telemetry.sdk.name: '"opentelemetry"'
+      telemetry.sdk.language: '"ruby"'
+      telemetry.sdk.version: counter('0.1.')
+    attributeOperations:
+      - 'copyFromParent("container", "container.name")'
+      - 'copyFromParent("container", "container.id")'
+      - 'copyFromParent("email", "service.name")'
+      - 'copyFromParent("email", "telemetry.sdk.language")'
+      - 'copyFromParent("email", "service.namespace")'
+      - 'modifyFromParent("email", "service.name", "service.instance_id", "counter(\"-\")")'
+  - name: currency
+    count: 3
+    childrenDistribution:
+      currency_instance: distribution(1, 1, 1)
+    attributes:
+      service.name: '"currency"'
+      service.namespace: '"opentelemetry-demo"'
+  - name: currency_instance
+    count: 6
+    attributes:
+      telemetry.sdk.name: '"opentelemetry"'
+      telemetry.sdk.language: '"cpp"'
+      telemetry.sdk.version: counter('0.1.')
+    attributeOperations:
+      - 'copyFromParent("container", "container.name")'
+      - 'copyFromParent("container", "container.id")'
+      - 'copyFromParent("currency", "service.name")'
+      - 'copyFromParent("currency", "telemetry.sdk.language")'
+      - 'copyFromParent("currency", "service.namespace")'
+      - 'modifyFromParent("currency", "service.name", "service.instance_id", "counter(\"-\")")'

example-definitions/demo/trace-definition.yaml

@@ -0,0 +1,49 @@
+#
+# Copyright 2022 AppDynamics Inc.
+#
+# Licensed 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.
+#
+
+traceCompletionTimeoutSecs: 120
+rootSpans:
+  - name: "checkout"
+    spanKind: SPAN_KIND_SERVER
+    reportingResource: frontend_instance
+    attributes:
+      http.method: '"POST"'
+      http.url: '"/checkout/".concat(UUIDFromStringCounter("checkout"))'
+    childSpans: ["doCheckout"]
+    payloadCount: 10
+    copyCount: 5
+childSpans:
+  - name: doCheckout
+    errorFrequency: 5
+    reportingResource: checkout_instance
+    spanKind: SPAN_KIND_SERVER
+    childSpans: ["sendEmail", "convertCurrency"]
+    attributes:
+      http.method: '"POST"'
+      http.url: '"/api/v1/checkout/".concat(UUIDFromStringCounter("checkout"))'
+  - name: sendEmail
+    reportingResource: email_instance
+    spanKind: SPAN_KIND_SERVER
+    attributes:
+      http.method: '"POST"'
+      http.url: '"/sendEmail"'
+  - name: convertCurrency
+    errorFrequency: 7
+    reportingResource: currency_instance
+    spanKind: SPAN_KIND_SERVER
+    attributes:
+      http.method: '"GET"'
+      http.url: '"/currency/convert/".concat(roundRobin(["YEN","BZR"])).concat("/").concat(roundRobin(["EUR", "USD"]))'

example-definitions/json/log-definition.json

@@ -0,0 +1,36 @@
+{
+  "globalPayloadFrequencySeconds": 30,
+  "logs": [
+    {
+      "attributes": {
+        "log.labels": "{\"generator\": roundRobin([\"Telemetry-Generator\", \"Telemetry-Generator-v2\"]), \"type\": \"k8s\"}"
+      },
+      "severityOrderFunction": "severityDistributionCount([\"INFO\", \"ERROR\", \"DEBUG\"], [1, 2, 3])",
+      "payloadFrequencySeconds": 20,
+      "payloadCount": 10,
+      "copyCount": 1000,
+      "reportingResourcesCounts": {
+        "container": 10,
+        "pod": 10
+      }
+    },
+    {
+      "severityOrderFunction": "severityDistributionCount([\"ERROR\", \"WARN\", \"DEBUG\"], [1, 1, 4])",
+      "payloadFrequencySeconds": 20,
+      "payloadCount": 2,
+      "copyCount": 200,
+      "reportingResourcesCounts": {
+        "node": 30
+      }
+    },
+    {
+      "severityOrderFunction": "severityDistributionPercentage([\"INFO\", \"TRACE\"], [20, 80])",
+      "payloadFrequencySeconds": 10,
+      "payloadCount": 5,
+      "reportingResourcesCounts": {
+        "ec2": 4,
+        "container": 150
+      }
+    }
+  ]
+}