Skip to content

Commit

Permalink
Add the sub-command service of command dependency (#113)
Browse files Browse the repository at this point in the history
  • Loading branch information
JarvisG495 authored Sep 6, 2021
1 parent 2b0f4d0 commit 660a355
Show file tree
Hide file tree
Showing 7 changed files with 194 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -564,6 +564,22 @@ You can imitate the content of [the default template file](examples/global.yml)

### `dependency`

#### `service`

<details>

<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. | |
| `--start` | See [Common options](#common-options) | See [Common options](#common-options) |
| `--end` | See [Common options](#common-options) | See [Common options](#common-options) |

</details>

#### `endpoint`

<details>
Expand Down
53 changes: 53 additions & 0 deletions assets/assets.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 33 additions & 0 deletions assets/graphqls/dependency/ServiceTopology.graphql
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# 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 ($serviceId: ID!, $duration: Duration!) {
result: getServiceTopology(duration: $duration, serviceId: $serviceId) {
nodes {
id
name
type
isReal
}
calls {
id
source
detectPoints
target
}
}
}
1 change: 1 addition & 0 deletions internal/commands/dependency/dependency.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,6 @@ var Command = cli.Command{
Usage: "Dependency related subcommand",
Subcommands: cli.Commands{
EndpointCommand,
ServiceCommand,
},
}
74 changes: 74 additions & 0 deletions internal/commands/dependency/service.go
Original file line number Diff line number Diff line change
@@ -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 ServiceCommand = cli.Command{
Name: "service",
ShortName: "svc",
Usage: "Query the dependencies of given service",
ArgsUsage: "<serviceId>",
Flags: flags.Flags(
flags.DurationFlags,
),
Before: interceptor.BeforeChain([]cli.BeforeFunc{
interceptor.TimezoneInterceptor,
interceptor.DurationInterceptor,
}),

Action: func(ctx *cli.Context) error {
if ctx.NArg() == 0 {
return fmt.Errorf("command service requires serviceId as argument")
}

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.ServiceTopology(ctx, ctx.Args().First(), duration)

if err != nil {
logger.Log.Fatalln(err)
}

return display.Display(ctx, &displayable.Displayable{Data: dependency})
},
}
12 changes: 12 additions & 0 deletions pkg/graphql/dependency/dependency.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,15 @@ func EndpointDependency(ctx *cli.Context, endpointID string, duration api.Durati

return response["result"], err
}

func ServiceTopology(ctx *cli.Context, serviceID string, duration api.Duration) (api.Topology, error) {
var response map[string]api.Topology

request := graphql.NewRequest(assets.Read("graphqls/dependency/ServiceTopology.graphql"))
request.Var("serviceId", serviceID)
request.Var("duration", duration)

err := client.ExecuteQuery(ctx, request, &response)

return response["result"], err
}
5 changes: 5 additions & 0 deletions scripts/test_commands.sh
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,8 @@ ${swctl} --display=json trace ls >/dev/null 2>&1

# Test `dashboard global`
${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

0 comments on commit 660a355

Please sign in to comment.