1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
package cgroups
import (
"bytes"
"fmt"
"hash/crc32"
"os"
"os/exec"
"path/filepath"
"strconv"
"strings"
"testing"
"github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus/ctxlogrus"
"github.com/prometheus/client_golang/prometheus/testutil"
"github.com/sirupsen/logrus"
"github.com/sirupsen/logrus/hooks/test"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v14/internal/command"
"gitlab.com/gitlab-org/gitaly/v14/internal/gitaly/config/cgroups"
"gitlab.com/gitlab-org/gitaly/v14/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v14/proto/go/gitalypb"
)
func defaultCgroupsConfig() cgroups.Config {
return cgroups.Config{
HierarchyRoot: "gitaly",
Repositories: cgroups.Repositories{
Count: 3,
MemoryBytes: 1024000,
CPUShares: 256,
},
}
}
func TestSetup(t *testing.T) {
mock := newMock(t)
v1Manager := &CGroupV1Manager{
cfg: defaultCgroupsConfig(),
hierarchy: mock.hierarchy,
}
require.NoError(t, v1Manager.Setup())
for i := 0; i < 3; i++ {
memoryPath := filepath.Join(
mock.root, "memory", "gitaly", fmt.Sprintf("gitaly-%d", os.Getpid()), fmt.Sprintf("repos-%d", i), "memory.limit_in_bytes",
)
memoryContent := readCgroupFile(t, memoryPath)
require.Equal(t, string(memoryContent), "1024000")
cpuPath := filepath.Join(
mock.root, "cpu", "gitaly", fmt.Sprintf("gitaly-%d", os.Getpid()), fmt.Sprintf("repos-%d", i), "cpu.shares",
)
cpuContent := readCgroupFile(t, cpuPath)
require.Equal(t, string(cpuContent), "256")
}
}
func TestAddCommand(t *testing.T) {
mock := newMock(t)
repo := &gitalypb.Repository{
StorageName: "default",
RelativePath: "path/to/repo.git",
}
config := defaultCgroupsConfig()
config.Repositories.Count = 1
config.Repositories.MemoryBytes = 1024
config.Repositories.CPUShares = 16
v1Manager1 := &CGroupV1Manager{
cfg: config,
hierarchy: mock.hierarchy,
}
require.NoError(t, v1Manager1.Setup())
ctx := testhelper.Context(t)
cmd1 := exec.Command("ls", "-hal", ".")
cmd2, err := command.New(ctx, cmd1, nil, nil, nil)
require.NoError(t, err)
require.NoError(t, cmd2.Wait())
v1Manager2 := &CGroupV1Manager{
cfg: config,
hierarchy: mock.hierarchy,
}
require.NoError(t, v1Manager2.AddCommand(cmd2, repo))
checksum := crc32.ChecksumIEEE([]byte(strings.Join([]string{"default", "path/to/repo.git"}, "")))
groupID := uint(checksum) % config.Repositories.Count
for _, s := range mock.subsystems {
path := filepath.Join(mock.root, string(s.Name()), "gitaly",
fmt.Sprintf("gitaly-%d", os.Getpid()), fmt.Sprintf("repos-%d", groupID), "cgroup.procs")
content := readCgroupFile(t, path)
pid, err := strconv.Atoi(string(content))
require.NoError(t, err)
require.Equal(t, cmd2.Pid(), pid)
}
}
func TestCleanup(t *testing.T) {
mock := newMock(t)
v1Manager := &CGroupV1Manager{
cfg: defaultCgroupsConfig(),
hierarchy: mock.hierarchy,
}
require.NoError(t, v1Manager.Setup())
require.NoError(t, v1Manager.Cleanup())
for i := 0; i < 3; i++ {
memoryPath := filepath.Join(mock.root, "memory", "gitaly", fmt.Sprintf("gitaly-%d", os.Getpid()), fmt.Sprintf("repos-%d", i))
cpuPath := filepath.Join(mock.root, "cpu", "gitaly", fmt.Sprintf("gitaly-%d", os.Getpid()), fmt.Sprintf("repos-%d", i))
require.NoDirExists(t, memoryPath)
require.NoDirExists(t, cpuPath)
}
}
func TestMetrics(t *testing.T) {
mock := newMock(t)
repo := &gitalypb.Repository{
StorageName: "default",
RelativePath: "path/to/repo.git",
}
config := defaultCgroupsConfig()
config.Repositories.Count = 1
config.Repositories.MemoryBytes = 1048576
config.Repositories.CPUShares = 16
v1Manager1 := newV1Manager(config)
v1Manager1.hierarchy = mock.hierarchy
mock.setupMockCgroupFiles(t, v1Manager1, 2)
require.NoError(t, v1Manager1.Setup())
ctx := testhelper.Context(t)
logger, hook := test.NewNullLogger()
logger.SetLevel(logrus.DebugLevel)
ctx = ctxlogrus.ToContext(ctx, logrus.NewEntry(logger))
cmd, err := command.New(ctx, exec.Command("ls", "-hal", "."), nil, nil, nil)
require.NoError(t, err)
gitCmd1, err := command.New(ctx, exec.Command("ls", "-hal", "."), nil, nil, nil)
require.NoError(t, err)
gitCmd2, err := command.New(ctx, exec.Command("ls", "-hal", "."), nil, nil, nil)
require.NoError(t, err)
require.NoError(t, v1Manager1.AddCommand(cmd, repo))
require.NoError(t, v1Manager1.AddCommand(gitCmd1, repo))
require.NoError(t, v1Manager1.AddCommand(gitCmd2, repo))
require.NoError(t, cmd.Wait())
require.NoError(t, gitCmd1.Wait())
repoCgroupPath := filepath.Join(v1Manager1.currentProcessCgroup(), "repos-0")
expected := bytes.NewBufferString(fmt.Sprintf(`# HELP gitaly_cgroup_cpu_usage CPU Usage of Cgroup
# TYPE gitaly_cgroup_cpu_usage gauge
gitaly_cgroup_cpu_usage{path="%s",type="kernel"} 0
gitaly_cgroup_cpu_usage{path="%s",type="user"} 0
# HELP gitaly_cgroup_memory_failed_total Number of memory usage hits limits
# TYPE gitaly_cgroup_memory_failed_total gauge
gitaly_cgroup_memory_failed_total{path="%s"} 2
# HELP gitaly_cgroup_procs_total Total number of procs
# TYPE gitaly_cgroup_procs_total gauge
gitaly_cgroup_procs_total{path="%s",subsystem="cpu"} 1
gitaly_cgroup_procs_total{path="%s",subsystem="memory"} 1
`, repoCgroupPath, repoCgroupPath, repoCgroupPath, repoCgroupPath, repoCgroupPath))
assert.NoError(t, testutil.CollectAndCompare(
v1Manager1,
expected))
logEntry := hook.LastEntry()
assert.Contains(
t,
logEntry.Data["command.cgroup_path"],
repoCgroupPath,
"log field includes a cgroup path that is a subdirectory of the current process' cgroup path",
)
}
func readCgroupFile(t *testing.T, path string) []byte {
t.Helper()
// The cgroups package defaults to permission 0 as it expects the file to be existing (the kernel creates the file)
// and its testing override the permission private variable to something sensible, hence we have to chmod ourselves
// so we can read the file.
require.NoError(t, os.Chmod(path, 0o666))
return testhelper.MustReadFile(t, path)
}
|
