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