github.com/inspektor-gadget/inspektor-gadget@v0.28.1/pkg/gadgets/top/file/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/top/file/types"
    21  	"github.com/inspektor-gadget/inspektor-gadget/pkg/params"
    22  	"github.com/inspektor-gadget/inspektor-gadget/pkg/parser"
    23  )
    24  
    25  type GadgetDesc struct{}
    26  
    27  func (g *GadgetDesc) Name() string {
    28  	return "file"
    29  }
    30  
    31  func (g *GadgetDesc) Category() string {
    32  	return gadgets.CategoryTop
    33  }
    34  
    35  func (g *GadgetDesc) Type() gadgets.GadgetType {
    36  	return gadgets.TypeTraceIntervals
    37  }
    38  
    39  func (g *GadgetDesc) Description() string {
    40  	return "Periodically report read/write activity by file"
    41  }
    42  
    43  func (g *GadgetDesc) ParamDescs() params.ParamDescs {
    44  	return params.ParamDescs{
    45  		{
    46  			Key:          types.AllFilesParam,
    47  			Title:        "Show all files",
    48  			DefaultValue: "false",
    49  			Description:  "include non-regular file types (sockets, FIFOs, etc)",
    50  			TypeHint:     params.TypeBool,
    51  		},
    52  	}
    53  }
    54  
    55  func (g *GadgetDesc) Parser() parser.Parser {
    56  	return parser.NewParser[types.Stats](types.GetColumns())
    57  }
    58  
    59  func (g *GadgetDesc) EventPrototype() any {
    60  	return &types.Stats{}
    61  }
    62  
    63  func (g *GadgetDesc) SortByDefault() []string {
    64  	return types.SortByDefault
    65  }
    66  
    67  func init() {
    68  	gadgetregistry.Register(&GadgetDesc{})
    69  }