github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/tracepoint/tracepoint.go (about)

     1  // Copyright (c) 2019 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package tracepoint
    22  
    23  // The tracepoint package is used to store operation names for tracing throughout dbnode.
    24  // The naming convention is as follows:
    25  
    26  // `packageName.objectName.method`
    27  
    28  // If there isn't an object, use `packageName.method`.
    29  
    30  const (
    31  	// FetchTagged is the operation name for the tchannelthrift FetchTagged path.
    32  	FetchTagged = "tchannelthrift/node.service.FetchTagged"
    33  
    34  	// Query is the operation name for the tchannelthrift Query path.
    35  	Query = "tchannelthrift/node.service.Query"
    36  
    37  	// FetchReadSingleResult is the operation name for the tchannelthrift FetchReadSingleResult path.
    38  	FetchReadSingleResult = "tchannelthrift/node.service.FetchReadSingleResult"
    39  
    40  	// FetchReadSegment is the operation name for the tchannelthrift FetchReadSegment path.
    41  	FetchReadSegment = "tchannelthrift/node.service.FetchReadSegment"
    42  
    43  	// AggregateTiles is the operation name for the tchannelthrift AggregateTiles path.
    44  	AggregateTiles = "tchannelthrift/node.service.AggregateTiles"
    45  
    46  	// DBQueryIDs is the operation name for the db QueryIDs path.
    47  	DBQueryIDs = "storage.db.QueryIDs"
    48  
    49  	// DBAggregateQuery is the operation name for the db AggregateQuery path.
    50  	DBAggregateQuery = "storage.db.AggregateQuery"
    51  
    52  	// DBFetchBlocks is the operation name for the db FetchBlocks path.
    53  	DBFetchBlocks = "storage.db.FetchBlocks"
    54  
    55  	// DBFetchBlocksMetadataV2 is the operation name for the db FetchBlocksMetadataV2 path.
    56  	DBFetchBlocksMetadataV2 = "storage.db.FetchBlocksMetadataV2"
    57  
    58  	// DBWriteBatch is the operation name for the db WriteBatch path.
    59  	DBWriteBatch = "storage.db.WriteBatch"
    60  
    61  	// DBFetchMismatch is the operation name for the tchannelthrift DBFetchMismatch path.
    62  	DBFetchMismatch = "storage.db.FetchMismatch"
    63  
    64  	// DBAggregateTiles is the operation name for the db AggregateTiles path.
    65  	DBAggregateTiles = "storage.db.AggregateTiles"
    66  
    67  	// NSQueryIDs is the operation name for the dbNamespace QueryIDs path.
    68  	NSQueryIDs = "storage.dbNamespace.QueryIDs"
    69  
    70  	// NSPrepareBootstrap is the operation name for the dbNamespace PrepareBootstrap path.
    71  	NSPrepareBootstrap = "storage.dbNamespace.PrepareBootstrap"
    72  
    73  	// NSBootstrap is the operation name for the dbNamespace Bootstrap path.
    74  	NSBootstrap = "storage.dbNamespace.Bootstrap"
    75  
    76  	// ShardPrepareBootstrap is the operation name for the dbShard PrepareBootstrap path.
    77  	ShardPrepareBootstrap = "storage.dbShard.PrepareBootstrap"
    78  
    79  	// ShardBootstrap is the operation name for the dbShard Bootstrap path.
    80  	ShardBootstrap = "storage.dbShard.Bootstrap"
    81  
    82  	// NSIdxQuery is the operation name for the nsIndex Query path.
    83  	NSIdxQuery = "storage.nsIndex.Query"
    84  
    85  	// NSIdxAggregateQuery is the operation name for the nsIndex AggregateQuery path.
    86  	NSIdxAggregateQuery = "storage.nsIndex.AggregateQuery"
    87  
    88  	// NSIdxQueryHelper is the operation name for the nsIndex query path.
    89  	NSIdxQueryHelper = "storage.nsIndex.query"
    90  
    91  	// NSIdxBlockQuery is the operation name for the nsIndex block query path.
    92  	NSIdxBlockQuery = "storage.nsIndex.blockQuery"
    93  
    94  	// NSIdxBlockAggregateQuery is the operation name for the nsIndex block aggregate query path.
    95  	NSIdxBlockAggregateQuery = "storage.nsIndex.blockAggregateQuery"
    96  
    97  	// NSIdxBlockQueryAddDocuments is the operation name for adding documents by batch in the block query path.
    98  	NSIdxBlockQueryAddDocuments = "storage.nsIndex.blockQueryAddDocuments"
    99  
   100  	// NSIdxBlockAggregateQueryAddDocuments is the operation name for adding documents by batch in the agg query path.
   101  	NSIdxBlockAggregateQueryAddDocuments = "storage.nsIndex.blockAggregateQueryAddDocuments"
   102  
   103  	// SearchExecutorIndexSearch is the operation name for searching on individual segment,
   104  	// in practice executed in the block query path.
   105  	SearchExecutorIndexSearch = "search.executor.IndexSearch"
   106  
   107  	// FieldTermsIteratorIndexSearch is the operation name for searching fields,
   108  	// in practice executed in the aggregate query path.
   109  	FieldTermsIteratorIndexSearch = "storage.index.fieldTermsIterator.IndexSearch"
   110  
   111  	// BlockQuery is the operation name for the index block query path.
   112  	BlockQuery = "storage/index.block.Query"
   113  
   114  	// BlockAggregate is the operation name for the index block aggregate path.
   115  	BlockAggregate = "storage/index.block.Aggregate"
   116  
   117  	// BootstrapProcessRun is the operation name for the bootstrap process Run path.
   118  	BootstrapProcessRun = "bootstrap.bootstrapProcess.Run"
   119  
   120  	// BootstrapperUninitializedSourceRead is the operation for the uninitializedTopologySource Read path.
   121  	BootstrapperUninitializedSourceRead = "bootstrapper.uninitialized.uninitializedTopologySource.Read"
   122  
   123  	// BootstrapperCommitLogSourceRead is the operation for the commit log Read path.
   124  	BootstrapperCommitLogSourceRead = "bootstrapper.commitlog.commitLogSource.Read"
   125  
   126  	// BootstrapperPeersSourceRead is the operation for the peers Read path.
   127  	BootstrapperPeersSourceRead = "bootstrapper.peers.peersSource.Read"
   128  
   129  	// BootstrapperFilesystemSourceRead is the operation for the filesystem Read path.
   130  	BootstrapperFilesystemSourceRead = "bootstrapper.fs.filesystemSource.Read"
   131  
   132  	// BootstrapperFilesystemSourceMigrator is the operation for filesystem migrator path.
   133  	BootstrapperFilesystemSourceMigrator = "bootstrapper.fs.filesystemSource.Migrator"
   134  
   135  	// WorkerPoolWait is the operation name for the waiting that occurs for a worker pool.
   136  	WorkerPoolWait = "x.sync.WorkerPoolWait"
   137  )