github.com/inspektor-gadget/inspektor-gadget@v0.28.1/pkg/gadgets/profile/cpu/tracer/gadget.go (about)

     1  // Copyright 2022-2023 The Inspektor Gadget authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package tracer
    16  
    17  import (
    18  	gadgetregistry "github.com/inspektor-gadget/inspektor-gadget/pkg/gadget-registry"
    19  	"github.com/inspektor-gadget/inspektor-gadget/pkg/gadgets"
    20  	"github.com/inspektor-gadget/inspektor-gadget/pkg/gadgets/profile/cpu/types"
    21  	"github.com/inspektor-gadget/inspektor-gadget/pkg/params"
    22  	"github.com/inspektor-gadget/inspektor-gadget/pkg/parser"
    23  )
    24  
    25  const (
    26  	ParamUserStack   = "user-stack"
    27  	ParamKernelStack = "kernel-stack"
    28  )
    29  
    30  type GadgetDesc struct{}
    31  
    32  func (g *GadgetDesc) Name() string {
    33  	return "cpu"
    34  }
    35  
    36  func (g *GadgetDesc) Category() string {
    37  	return gadgets.CategoryProfile
    38  }
    39  
    40  func (g *GadgetDesc) Type() gadgets.GadgetType {
    41  	return gadgets.TypeProfile
    42  }
    43  
    44  func (g *GadgetDesc) Description() string {
    45  	return "Analyze CPU performance by sampling stack traces"
    46  }
    47  
    48  func (g *GadgetDesc) ParamDescs() params.ParamDescs {
    49  	return params.ParamDescs{
    50  		{
    51  			Key:          ParamUserStack,
    52  			Alias:        "U",
    53  			Title:        "User Stack",
    54  			DefaultValue: "false",
    55  			Description:  "Show stacks from user space only (no kernel space stacks)",
    56  			TypeHint:     params.TypeBool,
    57  		},
    58  		{
    59  			Key:          ParamKernelStack,
    60  			Alias:        "K",
    61  			Title:        "Kernel Stack",
    62  			DefaultValue: "false",
    63  			Description:  "Show stacks from kernel space only (no user space stacks)",
    64  			TypeHint:     params.TypeBool,
    65  		},
    66  	}
    67  }
    68  
    69  func (g *GadgetDesc) Parser() parser.Parser {
    70  	return parser.NewParser[types.Report](types.GetColumns())
    71  }
    72  
    73  func (g *GadgetDesc) EventPrototype() any {
    74  	return &types.Report{}
    75  }
    76  
    77  func init() {
    78  	gadgetregistry.Register(&GadgetDesc{})
    79  }