Skip to content
This repository has been archived by the owner on Jun 1, 2022. It is now read-only.

PMM-5194 Tunnels #141

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ services:

go:
- 1.15.x
- 1.14.x
- tip
- 1.16.x
# TODO enable when 1.15.x is removed
# - tip

matrix:
fast_finish: true
Expand All @@ -16,10 +17,11 @@ matrix:

go_import_path: github.com/percona/pmm-admin

# skip non-trunk PMM-XXXX branch builds, but still build pull requests
# skip non-trunk PMM-XXXX/SAAS-XXXX branch builds, but still build pull requests
branches:
except:
- /^PMM\-\d{4}/
- /^PMM\-\d{3,5}/
- /^SAAS\-\d{2,5}/

cache:
directories:
Expand Down
8 changes: 5 additions & 3 deletions Gopkg.lock

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

3 changes: 2 additions & 1 deletion Gopkg.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ required = [

[[constraint]]
name = "github.com/percona/pmm"
branch = "PMM-2.0"
# branch = "PMM-2.0"
branch = "PMM-5194-tunnels"

# https://jira.percona.com/browse/PMM-4081
# https://jira.percona.com/browse/PMM-4042
Expand Down
38 changes: 30 additions & 8 deletions agentlocal/agentlocal.go
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,26 @@ type Status struct {
ServerVersion string `json:"server_version"`
AgentVersion string `json:"agent_version"`

Agents []AgentStatus `json:"agents"`
Agents []AgentStatus `json:"agents"`
Tunnels []TunnelStatus `json:"tunnels"`

Connected bool `json:"connected"`
ServerClockDrift time.Duration `json:"server_clock_drift,omitempty"`
ServerLatency time.Duration `json:"server_latency,omitempty"`
}

type AgentStatus struct {
AgentID string `json:"agent_id"`
AgentType string `json:"agent_type"`
Status string `json:"status"`
AgentID string `json:"agent_id"`
AgentType string `json:"agent_type"`
Status string `json:"status"`
ListenPort uint16 `json:"listen_port"`
}

type TunnelStatus struct {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [golangci-lint] reported by reviewdog 🐶
exported type TunnelStatus should have comment or be unexported (golint)

TunnelID string `json:"tunnel_id"`
ListenPort uint16 `json:"listen_port"`
ConnectPort uint16 `json:"connect_port"`
CurrentConnections uint `json:"current_connections"`
}

// GetRawStatus returns raw local pmm-agent status. No special cases.
Expand Down Expand Up @@ -123,11 +132,23 @@ func GetStatus(requestNetworkInfo NetworkInfo) (*Status, error) {
agents := make([]AgentStatus, len(p.AgentsInfo))
for i, a := range p.AgentsInfo {
agents[i] = AgentStatus{
AgentID: a.AgentID,
AgentType: pointer.GetString(a.AgentType),
Status: pointer.GetString(a.Status),
AgentID: a.AgentID,
AgentType: pointer.GetString(a.AgentType),
Status: pointer.GetString(a.Status),
ListenPort: uint16(a.ListenPort),
}
}

tunnels := make([]TunnelStatus, len(p.TunnelsInfo))
for i, t := range p.TunnelsInfo {
tunnels[i] = TunnelStatus{
TunnelID: t.TunnelID,
ListenPort: uint16(t.ListenPort),
ConnectPort: uint16(t.ConnectPort),
CurrentConnections: uint(t.CurrentConnections),
}
}

var clockDrift time.Duration
var latency time.Duration
if bool(requestNetworkInfo) && p.ServerInfo.Connected {
Expand Down Expand Up @@ -155,7 +176,8 @@ func GetStatus(requestNetworkInfo NetworkInfo) (*Status, error) {
ServerVersion: p.ServerInfo.Version,
AgentVersion: agentVersion,

Agents: agents,
Agents: agents,
Tunnels: tunnels,

Connected: p.ServerInfo.Connected,
ServerClockDrift: clockDrift,
Expand Down
113 changes: 113 additions & 0 deletions commands/inventory/list_tunnels.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
// pmm-admin
// Copyright 2019 Percona LLC
//
// 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.

package inventory

import (
"bytes"
"fmt"
"strconv"
"strings"
"text/tabwriter"

"github.com/percona/pmm/api/inventorypb/json/client"
"github.com/percona/pmm/api/inventorypb/json/client/tunnels"

"github.com/percona/pmm-admin/commands"
)

type listResultTunnel struct {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [golangci-lint] reported by reviewdog 🐶
struct of size 64 bytes could be of size 56 bytes (maligned)

TunnelID string `json:"tunnel_id"`
ListenAgentID string `json:"listen_agent_id"`
ListenPort uint16 `json:"listen_port"`
ConnectAgentID string `json:"connect_agent_id"`
ConnectPort uint16 `json:"connect_port"`
}

type listTunnelsResult struct {
Tunnels []listResultTunnel `json:"tunnels"`
}

func (res *listTunnelsResult) Result() {}

func (res *listTunnelsResult) String() string {
if len(res.Tunnels) == 0 {
return "No tunnels."
}

var buf bytes.Buffer
w := tabwriter.NewWriter(&buf, 0, 0, 3, ' ', 0)
header := strings.Join([]string{
"ID",
"Listen Agent ID",
"Listen port",
"Connect Agent ID",
"Connect port",
}, "\t")
fmt.Fprintln(w, header)
for _, t := range res.Tunnels {
line := strings.Join([]string{
t.TunnelID,
t.ListenAgentID,
strconv.Itoa(int(t.ListenPort)),
t.ConnectAgentID,
strconv.Itoa(int(t.ConnectPort)),
}, "\t")
fmt.Fprintln(w, line)
}
_ = w.Flush()

return buf.String()
}

type listTunnelsCommand struct {
filters tunnels.ListTunnelsBody
}

func (cmd *listTunnelsCommand) Run() (commands.Result, error) {
params := &tunnels.ListTunnelsParams{

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [golangci-lint] reported by reviewdog 🐶
HTTPClient is missing in ListTunnelsParams (exhaustivestruct)

Body: cmd.filters,
Context: commands.Ctx,
}
tunnelsRes, err := client.Default.Tunnels.ListTunnels(params)
if err != nil {
return nil, err
}

tunnelsList := make([]listResultTunnel, len(tunnelsRes.Payload.Tunnel))
for i, t := range tunnelsRes.Payload.Tunnel {
tunnelsList[i] = listResultTunnel{
TunnelID: t.TunnelID,
ListenAgentID: t.ListenAgentID,
ListenPort: uint16(t.ListenPort),
ConnectAgentID: t.ConnectAgentID,
ConnectPort: uint16(t.ConnectPort),
}
}

return &listTunnelsResult{
Tunnels: tunnelsList,
}, nil
}

// register command
var (
ListTunnels = new(listTunnelsCommand)
ListTunnelsC = inventoryListC.Command("tunnels", "Show tunnels in inventory").Hide(hide)
)

func init() {
ListTunnelsC.Flag("pmm-agent-id", "Filter by pmm-agent identifier").StringVar(&ListTunnels.filters.AgentID)
}
32 changes: 31 additions & 1 deletion commands/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@
package commands

import (
"bytes"
"context"
"fmt"
"net/url"
"strconv"
"strings"
"text/tabwriter"
"time"

"github.com/percona/pmm/api/inventorypb/types"
Expand Down Expand Up @@ -64,7 +68,33 @@ func (res *statusResult) NiceAgentStatus(status string) string {
func (res *statusResult) Result() {}

func (res *statusResult) String() string {
return RenderTemplate(statusResultT, res)
s := RenderTemplate(statusResultT, res)

if len(res.PMMAgentStatus.Tunnels) == 0 {
return s + "\n" + "No tunnels."
}

var buf bytes.Buffer
w := tabwriter.NewWriter(&buf, 0, 0, 3, ' ', 0)
header := strings.Join([]string{
"ID",
"Listen port",
"Connect port",
"Current connections",
}, "\t")
fmt.Fprintln(w, header)
for _, t := range res.PMMAgentStatus.Tunnels {
line := strings.Join([]string{
t.TunnelID,
strconv.Itoa(int(t.ListenPort)),
strconv.Itoa(int(t.ConnectPort)),
strconv.Itoa(int(t.CurrentConnections)),
}, "\t")
fmt.Fprintln(w, line)
}
_ = w.Flush()

return s + "\n" + buf.String()
}

func newStatusResult(status *agentlocal.Status) *statusResult {
Expand Down
2 changes: 2 additions & 0 deletions main.go
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ func main() {

inventory.RemoveAgentC.FullCommand(): inventory.RemoveAgent,

inventory.ListTunnelsC.FullCommand(): inventory.ListTunnels,

commands.ListC.FullCommand(): commands.List,
commands.AnnotationC.FullCommand(): commands.Annotation,
commands.StatusC.FullCommand(): commands.Status,
Expand Down

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

Loading