Zabbix

/*

** Zabbix

** Copyright (C) 2001-2025 Zabbix SIA

**

** This program is free software; you can redistribute it and/or modify

** it under the terms of the GNU General Public License as published by

** the Free Software Foundation; either version 2 of the License, or

** (at your option) any later version.

**

** This program is distributed in the hope that it will be useful,

** but WITHOUT ANY WARRANTY; without even the implied warranty of

** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

** GNU General Public License for more details.

**

** You should have received a copy of the GNU General Public License

** along with this program; if not, write to the Free Software

** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

**/

​

// Package metric provides an interface for describing a schema of metric's parameters.

package metric

​

import (

    "encoding/json"

    "fmt"

    "reflect"

    "strconv"

    "strings"

    "unicode"

​

    "zabbix.com/pkg/zbxerr"

)

​

type paramKind int

​

const (

    kindSession paramKind = iota

    kindConn

    kindGeneral

    kindSessionOnly

)

​

const (

    required = true

    optional = false

)

​

// Param stores parameters' metadata.

type Param struct {

    name         string

    description  string

    kind         paramKind

    required     bool

    validator    Validator

    defaultValue *string

}

​

func ucFirst(str string) string {

    for i, v := range str {

        return string(unicode.ToUpper(v)) + str[i+1:]

    }

​

    return ""

}

​

func newParam(name, description string, kind paramKind, required bool, validator Validator) *Param {

    name = strings.TrimSpace(name)

    if len(name) == 0 {

        panic("parameter name cannot be empty")

    }

​

    description = ucFirst(strings.TrimSpace(description))

    if len(description) == 0 {

        panic("parameter description cannot be empty")

    }

​

    if description[len(description)-1:] != "." {

        description += "."

    }

​

    return &Param{

        name:         name,

        description:  description,

        kind:         kind,

        required:     required,

        validator:    validator,

        defaultValue: nil,

    }

}

​

// NewParam creates a new parameter with given name and validator.