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

     1  // Copyright 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/params"
    21  	"github.com/inspektor-gadget/inspektor-gadget/pkg/parser"
    22  	"github.com/inspektor-gadget/inspektor-gadget/pkg/prometheus/config"
    23  )
    24  
    25  const (
    26  	ParamConfig = "config"
    27  )
    28  
    29  type fakeEvent struct{}
    30  
    31  type GadgetDesc struct{}
    32  
    33  func (g *GadgetDesc) Name() string {
    34  	return "prometheus"
    35  }
    36  
    37  func (g *GadgetDesc) Category() string {
    38  	return gadgets.CategoryNone
    39  }
    40  
    41  func (g *GadgetDesc) Type() gadgets.GadgetType {
    42  	return gadgets.TypeOther
    43  }
    44  
    45  func (g *GadgetDesc) Description() string {
    46  	return "Expose metrics using prometheus"
    47  }
    48  
    49  func (g *GadgetDesc) ParamDescs() params.ParamDescs {
    50  	return params.ParamDescs{
    51  		{
    52  			Key:         ParamConfig,
    53  			Title:       "config",
    54  			Description: "Metrics configuration (prefix with @ to load from a file)",
    55  			IsMandatory: true,
    56  			TypeHint:    params.TypeBytes,
    57  			Validator: func(value string) error {
    58  				_, err := config.ParseConfig([]byte(value))
    59  				return err
    60  			},
    61  		},
    62  	}
    63  }
    64  
    65  func (g *GadgetDesc) EventPrototype() any {
    66  	return &fakeEvent{}
    67  }
    68  
    69  func (g *GadgetDesc) Parser() parser.Parser {
    70  	return nil
    71  }
    72  
    73  func init() {
    74  	gadgetregistry.Register(&GadgetDesc{})
    75  }