go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/appengine/tsmon/doc.go (about)

     1  // Copyright 2016 The LUCI 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 tsmon adapts common/tsmon library to GAE environment.
    16  //
    17  // It configures tsmon state with a monitor and store suitable for GAE
    18  // environment and controls when metric flushes happen.
    19  //
    20  // Timeseries metrics are gathered automatically by the tsmon middleware and
    21  // staged in memory for export. Periodically, an unlucky single handler will
    22  // be chosen to perform this export at the end of its operation.
    23  //
    24  // A cron task MUST also be installed if metrics are enabled. The task assigns
    25  // and manages the task number assignments for active instances. If this cron
    26  // task is not installed, instances will not get IDs and will be unable to send
    27  // metrics. The cron task should be configured to hit:
    28  // "/internal/cron/ts_mon/housekeeping" every minute.
    29  //
    30  // Deprecated: do not depend on this package directly. tsmon is
    31  // initialized by go.chromium.org/luci/server by default. No additional cron
    32  // jobs are necessary.
    33  package tsmon