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
|
// Copyright (c) Contributors to the Apptainer project, established as
// Apptainer a Series of LF Projects LLC.
// For website terms of use, trademark policy, privacy policy and other
// project policies see https://lfprojects.org/policies
// Copyright (c) 2022, Vanessa Sochat. All rights reserved.
// This software is licensed under a 3-clause BSD license. Please consult the
// LICENSE.md file distributed with the sources of this project regarding your
// rights to use or distribute this software.
package cli
import (
"os"
"github.com/apptainer/apptainer/docs"
"github.com/apptainer/apptainer/internal/app/apptainer"
"github.com/apptainer/apptainer/pkg/cmdline"
"github.com/apptainer/apptainer/pkg/sylog"
"github.com/spf13/cobra"
)
// Basic Design
// apptainer instance stats <name>
// apptainer instance stats --json <name>
func init() {
addCmdInit(func(cmdManager *cmdline.CommandManager) {
cmdManager.RegisterFlagForCmd(&instanceStatsUserFlag, instanceStatsCmd)
cmdManager.RegisterFlagForCmd(&instanceStatsJSONFlag, instanceStatsCmd)
cmdManager.RegisterFlagForCmd(&instanceStatsNoStreamFlag, instanceStatsCmd)
})
}
// -u|--user
var instanceStatsUser string
var instanceStatsUserFlag = cmdline.Flag{
ID: "instanceStatsUserFlag",
Value: &instanceStatsUser,
DefaultValue: "",
Name: "user",
ShortHand: "u",
Usage: "view stats for an instance belonging to a user (root only)",
Tag: "<username>",
EnvKeys: []string{"USER"},
}
// -j|--json
var instanceStatsJSON bool
var instanceStatsJSONFlag = cmdline.Flag{
ID: "instanceStatsJSONFlag",
Value: &instanceStatsJSON,
DefaultValue: false,
Name: "json",
ShortHand: "j",
Usage: "output stats in json",
}
// --no-stream
var instanceStatsNoStream bool
var instanceStatsNoStreamFlag = cmdline.Flag{
ID: "instanceStatsNoStreamFlag",
Value: &instanceStatsNoStream,
DefaultValue: false,
Name: "no-stream",
Usage: "disable streaming (live update) of instance stats",
}
// apptainer instance stats
var instanceStatsCmd = &cobra.Command{
Args: cobra.ExactArgs(1),
DisableFlagsInUseLine: true,
RunE: func(cmd *cobra.Command, args []string) error {
uid := os.Getuid()
// Root is required to look at stats for another user
if instanceStatsUser != "" && uid != 0 {
sylog.Fatalf("Only the root user can look at stats of a user's instance")
}
// Instance name is the only arg
name := args[0]
return apptainer.InstanceStats(cmd.Context(), name, instanceStatsUser, instanceStatsJSON, instanceStatsNoStream)
},
Use: docs.InstanceStatsUse,
Short: docs.InstanceStatsShort,
Long: docs.InstanceStatsLong,
Example: docs.InstanceStatsExample,
}
|
