You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by ke...@apache.org on 2021/09/29 03:03:06 UTC
[skywalking-cli] branch master updated: Add the sub-command
'instance' of command 'dependency' (#117)
This is an automated email from the ASF dual-hosted git repository.
kezhenxu94 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/skywalking-cli.git
The following commit(s) were added to refs/heads/master by this push:
new 7742a5c Add the sub-command 'instance' of command 'dependency' (#117)
7742a5c is described below
commit 7742a5c6404c897cec6c19fc5be1598e670d16fc
Author: JarvisG495 <86...@users.noreply.github.com>
AuthorDate: Tue Sep 28 23:02:58 2021 -0400
Add the sub-command 'instance' of command 'dependency' (#117)
---
README.md | 20 +++++-
assets/assets.gen.go | 55 ++++++++++++++++
.../graphqls/dependency/InstanceTopology.graphql | 35 ++++++++++
internal/commands/dependency/dependency.go | 1 +
internal/commands/dependency/instance.go | 74 ++++++++++++++++++++++
pkg/graphql/dependency/dependency.go | 13 ++++
scripts/test_commands.sh | 4 +-
7 files changed, 199 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
index 9e6cb67..4ccc46a 100644
--- a/README.md
+++ b/README.md
@@ -582,13 +582,13 @@ You can imitate the content of [the default template file](examples/global.yml)
<details>
-<summary>dependency service <service-id> [--start=start-time] [--end=end-time]</summary>
+<summary>dependency service [service-id] [--start=start-time] [--end=end-time]</summary>
`dependency service` shows all the dependencies of given `[service-id]` in the time range of `[start, end]`.
| argument | description | default |
| :--- | :--- | :--- |
-| `service-id` | The service id whose dependencies are to displayed. | |
+| `service-id` | The service id whose dependencies are to displayed. |
| `--start` | See [Common options](#common-options) | See [Common options](#common-options) |
| `--end` | See [Common options](#common-options) | See [Common options](#common-options) |
@@ -610,6 +610,22 @@ You can imitate the content of [the default template file](examples/global.yml)
</details>
+#### `instance`
+
+<details>
+
+<summary>dependency instance [clientService-id] [serverService-id] [--start=start-time] [--end=end-time]</summary>
+
+`dependency instance` shows the instance topology of given `[clientService-id]` and `[serverService-id]` in the time range of `[start, end]`.
+
+| argument | description | default |
+| :--- | :--- | :--- |
+| `clientService-id` | The service id of the client. | |
+| `serverService-id` | The service id of the server. | |
+| `--start` | See [Common options](#common-options) | See [Common options](#common-options) |
+| `--end` | See [Common options](#common-options) | See [Common options](#common-options) |
+
+</details>
# Use Cases
diff --git a/assets/assets.gen.go b/assets/assets.gen.go
index de5df31..efd15d8 100644
--- a/assets/assets.gen.go
+++ b/assets/assets.gen.go
@@ -20,6 +20,7 @@
// cr/oap.yaml (942B)
// cr/ui.yaml (935B)
// graphqls/dependency/EndpointDependency.graphql (1.207kB)
+// graphqls/dependency/InstanceTopology.graphql (1.272kB)
// graphqls/dependency/ServiceTopology.graphql (1.137kB)
// graphqls/event/events.graphql (1.256kB)
// graphqls/healthcheck/healthcheck.graphql (870B)
@@ -222,6 +223,58 @@ func graphqlsDependencyEndpointdependencyGraphql() (*asset, error) {
return a, nil
}
+var _graphqlsDependencyInstancetopologyGraphql = []byte(`# Licensed to 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. Apache Software Foundation (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.
+
+query ($clientServiceId: ID!, $serverServiceId: ID!, $duration: Duration!) {
+ result: getServiceInstanceTopology(duration: $duration, clientServiceId: $clientServiceId, serverServiceId: $serverServiceId) {
+ nodes {
+ id
+ name
+ type
+ isReal
+ serviceName
+ serviceId
+ }
+ calls {
+ id
+ source
+ detectPoints
+ target
+ }
+ }
+}
+`)
+
+func graphqlsDependencyInstancetopologyGraphqlBytes() ([]byte, error) {
+ return _graphqlsDependencyInstancetopologyGraphql, nil
+}
+
+func graphqlsDependencyInstancetopologyGraphql() (*asset, error) {
+ bytes, err := graphqlsDependencyInstancetopologyGraphqlBytes()
+ if err != nil {
+ return nil, err
+ }
+
+ info := bindataFileInfo{name: "graphqls/dependency/InstanceTopology.graphql", size: 0, mode: os.FileMode(0), modTime: time.Unix(0, 0)}
+ a := &asset{bytes: bytes, info: info, digest: [32]uint8{0x8b, 0x83, 0x9c, 0xab, 0x61, 0xdb, 0x37, 0xc6, 0xad, 0x3b, 0x40, 0x65, 0x4b, 0x75, 0x57, 0x99, 0x72, 0xf5, 0xcd, 0x76, 0x49, 0x79, 0xda, 0xf8, 0x2f, 0xb8, 0x30, 0x69, 0x9a, 0x94, 0xa9, 0xf4}}
+ return a, nil
+}
+
var _graphqlsDependencyServicetopologyGraphql = []byte(`# Licensed to Apache Software Foundation (ASF) under one or more contributor
# license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright
@@ -1428,6 +1481,7 @@ var _bindata = map[string]func() (*asset, error){
"cr/oap.yaml": crOapYaml,
"cr/ui.yaml": crUiYaml,
"graphqls/dependency/EndpointDependency.graphql": graphqlsDependencyEndpointdependencyGraphql,
+ "graphqls/dependency/InstanceTopology.graphql": graphqlsDependencyInstancetopologyGraphql,
"graphqls/dependency/ServiceTopology.graphql": graphqlsDependencyServicetopologyGraphql,
"graphqls/event/events.graphql": graphqlsEventEventsGraphql,
"graphqls/healthcheck/healthcheck.graphql": graphqlsHealthcheckHealthcheckGraphql,
@@ -1504,6 +1558,7 @@ var _bintree = &bintree{nil, map[string]*bintree{
"graphqls": &bintree{nil, map[string]*bintree{
"dependency": &bintree{nil, map[string]*bintree{
"EndpointDependency.graphql": &bintree{graphqlsDependencyEndpointdependencyGraphql, map[string]*bintree{}},
+ "InstanceTopology.graphql": &bintree{graphqlsDependencyInstancetopologyGraphql, map[string]*bintree{}},
"ServiceTopology.graphql": &bintree{graphqlsDependencyServicetopologyGraphql, map[string]*bintree{}},
}},
"event": &bintree{nil, map[string]*bintree{
diff --git a/assets/graphqls/dependency/InstanceTopology.graphql b/assets/graphqls/dependency/InstanceTopology.graphql
new file mode 100644
index 0000000..b52ff99
--- /dev/null
+++ b/assets/graphqls/dependency/InstanceTopology.graphql
@@ -0,0 +1,35 @@
+# Licensed to 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. Apache Software Foundation (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.
+
+query ($clientServiceId: ID!, $serverServiceId: ID!, $duration: Duration!) {
+ result: getServiceInstanceTopology(duration: $duration, clientServiceId: $clientServiceId, serverServiceId: $serverServiceId) {
+ nodes {
+ id
+ name
+ type
+ isReal
+ serviceName
+ serviceId
+ }
+ calls {
+ id
+ source
+ detectPoints
+ target
+ }
+ }
+}
diff --git a/internal/commands/dependency/dependency.go b/internal/commands/dependency/dependency.go
index b719293..fa13b33 100644
--- a/internal/commands/dependency/dependency.go
+++ b/internal/commands/dependency/dependency.go
@@ -28,5 +28,6 @@ var Command = cli.Command{
Subcommands: cli.Commands{
EndpointCommand,
ServiceCommand,
+ InstanceCommand,
},
}
diff --git a/internal/commands/dependency/instance.go b/internal/commands/dependency/instance.go
new file mode 100644
index 0000000..6285fba
--- /dev/null
+++ b/internal/commands/dependency/instance.go
@@ -0,0 +1,74 @@
+// Licensed to 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. Apache Software Foundation (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.
+
+package dependency
+
+import (
+ "fmt"
+
+ "github.com/urfave/cli"
+
+ "github.com/apache/skywalking-cli/internal/commands/interceptor"
+ "github.com/apache/skywalking-cli/internal/flags"
+ "github.com/apache/skywalking-cli/internal/logger"
+ "github.com/apache/skywalking-cli/internal/model"
+
+ "github.com/apache/skywalking-cli/pkg/display"
+ "github.com/apache/skywalking-cli/pkg/display/displayable"
+
+ "github.com/apache/skywalking-cli/pkg/graphql/dependency"
+
+ api "skywalking.apache.org/repo/goapi/query"
+)
+
+var InstanceCommand = cli.Command{
+ Name: "instance",
+ ShortName: "instc",
+ Usage: "Query the instance topology, based on the given clientServiceId and serverServiceId",
+ ArgsUsage: "<clientServiceId> <serverServiceId>",
+ Flags: flags.Flags(
+ flags.DurationFlags,
+ ),
+ Before: interceptor.BeforeChain([]cli.BeforeFunc{
+ interceptor.TimezoneInterceptor,
+ interceptor.DurationInterceptor,
+ }),
+
+ Action: func(ctx *cli.Context) error {
+ if ctx.NArg() < 2 {
+ return fmt.Errorf("command instance requires both clientServiceId and serverServiceId as arguments")
+ }
+
+ end := ctx.String("end")
+ start := ctx.String("start")
+ step := ctx.Generic("step")
+
+ duration := api.Duration{
+ Start: start,
+ End: end,
+ Step: step.(*model.StepEnumValue).Selected,
+ }
+
+ dependency, err := dependency.InstanceTopology(ctx, ctx.Args().First(), ctx.Args().Get(1), duration)
+
+ if err != nil {
+ logger.Log.Fatalln(err)
+ }
+
+ return display.Display(ctx, &displayable.Displayable{Data: dependency})
+ },
+}
diff --git a/pkg/graphql/dependency/dependency.go b/pkg/graphql/dependency/dependency.go
index 8b28ea6..19f3d05 100644
--- a/pkg/graphql/dependency/dependency.go
+++ b/pkg/graphql/dependency/dependency.go
@@ -50,3 +50,16 @@ func ServiceTopology(ctx *cli.Context, serviceID string, duration api.Duration)
return response["result"], err
}
+
+func InstanceTopology(ctx *cli.Context, clientServiceID, serverServiceID string, duration api.Duration) (api.ServiceInstanceTopology, error) {
+ var response map[string]api.ServiceInstanceTopology
+
+ request := graphql.NewRequest(assets.Read("graphqls/dependency/InstanceTopology.graphql"))
+ request.Var("clientServiceId", clientServiceID)
+ request.Var("serverServiceId", serverServiceID)
+ request.Var("duration", duration)
+
+ err := client.ExecuteQuery(ctx, request, &response)
+
+ return response["result"], err
+}
diff --git a/scripts/test_commands.sh b/scripts/test_commands.sh
index 59f41f0..f757d90 100755
--- a/scripts/test_commands.sh
+++ b/scripts/test_commands.sh
@@ -70,4 +70,6 @@ ${swctl} --display=json db g >/dev/null 2>&1
# Test `dependency`
${swctl} --display=json dependency service "test" > /dev/null 2>&1
-${swctl} --display=json dependency endpoint "test" > /dev/null 2>&1
\ No newline at end of file
+${swctl} --display=json dependency endpoint "test" > /dev/null 2>&1
+
+${swctl} --display=json dependency instance "test" "test" > /dev/null 2>&1