github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/pkg/sql/sqltelemetry/doc.go (about)

     1  // Copyright 2019 The Cockroach Authors.
     2  //
     3  // Use of this software is governed by the Business Source License
     4  // included in the file licenses/BSL.txt.
     5  //
     6  // As of the Change Date specified in that file, in accordance with
     7  // the Business Source License, use of this software will be governed
     8  // by the Apache License, Version 2.0, included in the file
     9  // licenses/APL.txt.
    10  
    11  /*
    12  Package sqltelemetry contains telemetry counter definitions
    13  for various SQL features.
    14  
    15  Centralizing the counters in a single place achieves three objectives:
    16  
    17  - the comments that accompany the counters enable non-technical users
    18    to comprehend what is being reported without having to read code.
    19  
    20  - the counters are placed side-by-side, grouped by category, so as to
    21    enable exploratory discovery of available telemetry.
    22  
    23  - the counters are pre-registered and their unicity is asserted,
    24    so that no two features end up using the same counter name.
    25  */
    26  package sqltelemetry