Skip to content

Commit 3f5dc68

Browse files
authored
PMM-12631 removed alertmanager configs from logs. (#2584)
* PMM-12631 removed alertmanager configs from logs. * PMM-12631 removed alertmanager configs from tests and docs. * PMM-12631 Fix linter.
1 parent 353542d commit 3f5dc68

File tree

5 files changed

+3
-39
lines changed

5 files changed

+3
-39
lines changed

api-tests/server/logs_test.go

-2
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,8 @@ func TestDownloadLogs(t *testing.T) {
4444
assert.NoError(t, err)
4545

4646
expected := []string{
47-
"alertmanager.base.yml",
4847
"alertmanager.ini",
4948
"alertmanager.log",
50-
"alertmanager.yml",
5149
"clickhouse-server.log",
5250
"client/list.txt",
5351
"client/pmm-admin-version.txt",

docs/api/pmm-server-config/troubleshooting/logs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The structure of the logs is as follows:
1313
{
1414
"codes": [
1515
{
16-
"code": "# tree\n├── alertmanager.base.yml\n├── alertmanager.ini\n├── alertmanager.log\n├── alertmanager.yml\n├── clickhouse-server.err.log\n├── clickhouse-server.log\n├── clickhouse-server.startup.log\n├── client\n│ ├── list.txt\n│ ├── pmm-admin-version.txt\n│ ├── pmm-agent-config.yaml\n│ ├── pmm-agent-version.txt\n│ └── status.json\n├── cron.log\n├── dashboard-upgrade.log\n├── dbaas-controller.log\n├── grafana.log\n├── installed.json\n├── nginx.conf\n├── nginx.log\n├── nginx.startup.log\n├── pmm-agent.log\n├── pmm-agent.yaml\n├── pmm-managed.log\n├── pmm-ssl.conf\n├── pmm-update-perform-init.log\n├── pmm-update-perform.log\n├── pmm-version.txt\n├── pmm.conf\n├── pmm.ini\n├── postgresql.log\n├── postgresql.startup.log\n├── prometheus.base.yml\n├── prometheus.log\n├── qan-api2.ini\n├── qan-api2.log\n├── supervisorctl_status.log\n├── supervisord.conf\n├── supervisord.log\n├── systemctl_status.log\n├── victoriametrics-promscrape.yml\n├── victoriametrics.ini\n├── victoriametrics.log\n├── victoriametrics_targets.json\n├── vmalert.ini\n└── vmalert.log",
16+
"code": "# tree\n├── alertmanager.ini\n├── alertmanager.log\n├── clickhouse-server.err.log\n├── clickhouse-server.log\n├── clickhouse-server.startup.log\n├── client\n│ ├── list.txt\n│ ├── pmm-admin-version.txt\n│ ├── pmm-agent-config.yaml\n│ ├── pmm-agent-version.txt\n│ └── status.json\n├── cron.log\n├── dashboard-upgrade.log\n├── dbaas-controller.log\n├── grafana.log\n├── installed.json\n├── nginx.conf\n├── nginx.log\n├── nginx.startup.log\n├── pmm-agent.log\n├── pmm-agent.yaml\n├── pmm-managed.log\n├── pmm-ssl.conf\n├── pmm-update-perform-init.log\n├── pmm-update-perform.log\n├── pmm-version.txt\n├── pmm.conf\n├── pmm.ini\n├── postgresql.log\n├── postgresql.startup.log\n├── prometheus.base.yml\n├── prometheus.log\n├── qan-api2.ini\n├── qan-api2.log\n├── supervisorctl_status.log\n├── supervisord.conf\n├── supervisord.log\n├── systemctl_status.log\n├── victoriametrics-promscrape.yml\n├── victoriametrics.ini\n├── victoriametrics.log\n├── victoriametrics_targets.json\n├── vmalert.ini\n└── vmalert.log",
1717
"language": "text"
1818
}
1919
]

managed/services/checks/checks.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -1490,7 +1490,7 @@ func (s *Service) filterSupportedChecks(advisors []check.Advisor) []check.Adviso
14901490
for _, advisor := range advisors {
14911491
checks := make([]check.Check, 0, len(advisor.Checks))
14921492

1493-
loop:
1493+
LOOP:
14941494
for _, c := range advisor.Checks {
14951495
if c.Version > maxSupportedVersion {
14961496
s.l.Warnf("Unsupported checks version: %d, max supported version: %d.", c.Version, maxSupportedVersion)
@@ -1507,7 +1507,7 @@ func (s *Service) filterSupportedChecks(advisors []check.Advisor) []check.Adviso
15071507
for _, query := range c.Queries {
15081508
if ok := isQueryTypeSupported(query.Type); !ok {
15091509
s.l.Warnf("Unsupported query type: %s.", query.Type)
1510-
continue loop
1510+
continue LOOP
15111511
}
15121512
}
15131513
}

managed/services/supervisord/logs.go

-32
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,8 @@ import (
3232
"sync"
3333
"time"
3434

35-
"github.com/percona/promconfig/alertmanager"
3635
"github.com/pkg/errors"
3736
"golang.org/x/sys/unix"
38-
"gopkg.in/yaml.v3"
3937

4038
pprofUtils "github.com/percona/pmm/managed/utils/pprof"
4139
"github.com/percona/pmm/utils/logger"
@@ -149,23 +147,6 @@ func (l *Logs) files(ctx context.Context, pprofConfig *PprofConfig) []fileConten
149147
Err: err,
150148
})
151149
}
152-
for _, f := range []string{
153-
"/etc/alertmanager.yml",
154-
"/srv/alertmanager/alertmanager.base.yml",
155-
} {
156-
b, m, err := readFile(f)
157-
if err == nil {
158-
b, err = maskAlertManagerSensitiveValues(b)
159-
files = append(files, fileContent{
160-
Name: filepath.Base(f),
161-
Modified: m,
162-
Data: b,
163-
Err: err,
164-
})
165-
} else {
166-
logger.Get(ctx).WithField("component", "logs").Error(err)
167-
}
168-
}
169150
// add configs
170151
for _, f := range []string{
171152
"/etc/nginx/nginx.conf",
@@ -443,16 +424,3 @@ func addAdminSummary(ctx context.Context, zw *zip.Writer) error {
443424

444425
return nil
445426
}
446-
447-
func maskAlertManagerSensitiveValues(data []byte) ([]byte, error) {
448-
var c alertmanager.Config
449-
err := yaml.Unmarshal(data, &c)
450-
if err != nil {
451-
return data, err
452-
}
453-
nc, err := c.Mask()
454-
if err != nil {
455-
return data, err
456-
}
457-
return yaml.Marshal(nc)
458-
}

managed/services/supervisord/logs_test.go

-2
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,8 @@ import (
3636
)
3737

3838
var commonExpectedFiles = []string{
39-
"alertmanager.base.yml",
4039
"alertmanager.ini",
4140
"alertmanager.log",
42-
"alertmanager.yml",
4341
"clickhouse-server.log",
4442
"grafana.log",
4543
"installed.json",

0 commit comments

Comments
 (0)