m_sql.go

// Copyright 2022 Matrix Origin
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package metric

var (
	StatementCounterFactory = NewCounterVec(
		CounterOpts{
			Subsystem: "sql",
			Name:      "statement_total",
			Help:      "Counter of executed sql statement",
		},
		[]string{constTenantKey, "type"},
		false,
	)

	StatementDurationFactory = NewCounterVec(
		CounterOpts{
			Subsystem: "sql",
			Name:      "statement_duration_total",
			Help:      "Statement duration of each query type for each account",
		},
		[]string{constTenantKey, "type"},
		false,
	)

	TransactionCounterFactory = NewCounterVec(
		CounterOpts{
			Subsystem: "sql",
			Name:      "transaction_total",
			Help:      "Counter of transaction",
		},
		[]string{constTenantKey},
		false,
	)

	TransactionErrorsFactory = NewCounterVec(
		CounterOpts{
			Subsystem: "sql",
			Name:      "transaction_errors",
			Help:      "Counter of errors on execute commit/rollback statement",
		},
		[]string{constTenantKey, "type"},
		false,
	)

	StatementErrorsFactory = NewCounterVec(
		CounterOpts{
			Subsystem: "sql",
			Name:      "statement_errors",
			Help:      "Counter of executed sql statement failed.",
		},
		[]string{constTenantKey, "type"},
		false,
	)

	StatementCUCounterFactory = NewCounterVec(
		CounterOpts{
			Subsystem: "sql",
			Name:      "statement_cu",
			Help:      "Counter of executed sql statement cu",
		},
		[]string{constTenantKey, "sql_source_type"},
		false,
	)
)

type SQLType string

var (
	SQLTypeSelect SQLType = "select"
	SQLTypeInsert SQLType = "insert"
	SQLTypeUpdate SQLType = "update"
	SQLTypeDelete SQLType = "delete"
	SQLTypeOther  SQLType = "other"

	SQLTypeBegin        SQLType = "begin"
	SQLTypeCommit       SQLType = "commit"
	SQLTypeRollback     SQLType = "rollback"
	SQLTypeAutoCommit   SQLType = "auto_commit"
	SQLTypeAutoRollback SQLType = "auto_rollback"
)

// StatementCounter accept t as tree.QueryType
func StatementCounter(tenant string, t string) Counter {
	return StatementCounterFactory.WithLabelValues(tenant, t)
}

func StatementDuration(tenant string, t string) Counter {
	return StatementDurationFactory.WithLabelValues(tenant, t)
}

func TransactionCounter(tenant string) Counter {
	return TransactionCounterFactory.WithLabelValues(tenant)
}

func TransactionErrorsCounter(account string, t SQLType) Counter {
	return TransactionErrorsFactory.WithLabelValues(account, string(t))
}

// StatementErrorsCounter accept t as tree.QueryType
func StatementErrorsCounter(account string, t string) Counter {
	return StatementErrorsFactory.WithLabelValues(account, t)
}

// StatementCUCounter accept @account, @sqlSourceType
// @account is the account name of the user who executes the sql statement.
// @sqlSourceType is the type of sql source, such as InternalSql, CloudNoUserSql, ExternalSql, CloudUserSql etc.
func StatementCUCounter(account string, sqlSourceType string) Counter {
	return StatementCUCounterFactory.WithLabelValues(account, sqlSourceType)
}