github.com/coyove/sdss@v0.0.0-20231129015646-c2ec58cca6a2/future/chrony/doc.go (about)

     1  /*
     2  Copyright (c) Facebook, Inc. and its affiliates.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  /*
    18  Package chrony implements Chrony (https://chrony.tuxfamily.org) network protocol v6 used for monitoring of the timeserver.
    19  
    20  As of now, only monitoring part of protocol that is used to communicate between `chronyc` and `chronyd` is implemented.
    21  Chronyc/chronyd protocol is not documented (https://chrony.tuxfamily.org/faq.html#_is_the_code_chronyc_code_code_chronyd_code_protocol_documented_anywhere).
    22  
    23  Library allows communicating with Chrony NTP server,
    24  and get various information, for example: current server status; server variables like offset; peers with their statuses and variables; server counters.
    25  
    26  Example usage can be found in ntpcheck project - https://github.com/facebook/time/ntp/ntpcheck
    27  */
    28  package chrony