github.com/inspektor-gadget/inspektor-gadget@v0.28.1/pkg/gadgets/categories.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 gadgets
    16  
    17  const (
    18  	CategoryNone     = ""
    19  	CategoryAdvise   = "advise"
    20  	CategoryAudit    = "audit"
    21  	CategoryProfile  = "profile"
    22  	CategorySnapshot = "snapshot"
    23  	CategoryTop      = "top"
    24  	CategoryTrace    = "trace"
    25  	CategoryOther    = "other"
    26  )
    27  
    28  var categories = map[string]string{
    29  	CategoryAdvise:   "Recommend system configurations based on collected information",
    30  	CategoryAudit:    "Audit a subsystem",
    31  	CategoryProfile:  "Profile different subsystems",
    32  	CategorySnapshot: "Take a snapshot of a subsystem and print it",
    33  	CategoryTop:      "Gather, sort and periodically report events according to a given criteria",
    34  	CategoryTrace:    "Trace and print system events",
    35  	CategoryOther:    "Other Gadgets",
    36  }
    37  
    38  // GetCategories returns a map of category name to category description
    39  func GetCategories() map[string]string {
    40  	return categories
    41  }