src/lib/core/CHIPEventLoggingConfig.h

   1 /*
   2  *
   3  *    Copyright (c) 2020 Project CHIP Authors
   4  *    Copyright (c) 2016-2017 Nest Labs, Inc.
   5  *
   6  *    Licensed under the Apache License, Version 2.0 (the "License");
   7  *    you may not use this file except in compliance with the License.
   8  *    You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *    Unless required by applicable law or agreed to in writing, software
  13  *    distributed under the License is distributed on an "AS IS" BASIS,
  14  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *    See the License for the specific language governing permissions and
  16  *    limitations under the License.
  17  */
  18
  19 /**
  20  *    @file
  21  *      This file defines compile time configuration of the Event Logging profile
  22  */
  23
  24 #pragma once
  25
  26 /**
  27  * @def CHIP_CONFIG_EVENT_SIZE_RESERVE
  28  *
  29  * @brief
  30  *   Initial size to reserve for event. The logging subsystem ensures
  31  *   this space is available in the buffer before attempting to store
  32  *   the event.
  33  */
  34 #ifndef CHIP_CONFIG_EVENT_SIZE_RESERVE
  35 #define CHIP_CONFIG_EVENT_SIZE_RESERVE 196
  36 #endif /* CHIP_CONFIG_EVENT_SIZE_RESERVE */
  37
  38 /**
  39  * @def CHIP_CONFIG_EVENT_SIZE_INCREMENT
  40  *
  41  * @brief
  42  *   When the initial reserved size proves insufficient, clean out the
  43  *   buffer in following increments.
  44  */
  45 #ifndef CHIP_CONFIG_EVENT_SIZE_INCREMENT
  46 #define CHIP_CONFIG_EVENT_SIZE_INCREMENT 8
  47 #endif /* CHIP_CONFIG_EVENT_SIZE_INCREMENT */
  48
  49 /**
  50  * @def CHIP_CONFIG_EVENT_LOGGING_MAXIMUM_UPLOAD_SECONDS
  51  *
  52  * @brief
  53  *   The maximum time (in seconds) between log uploads.  The
  54  *   system is guaranteed to attempt to offload the log buffer at
  55  *   least this often.  The value is used to initialize chip
  56  *   LoggingConfiguration. This is only relevant for BDX uploads.
  57  */
  58 #ifndef CHIP_CONFIG_EVENT_LOGGING_MAXIMUM_UPLOAD_SECONDS
  59 #define CHIP_CONFIG_EVENT_LOGGING_MAXIMUM_UPLOAD_SECONDS 86400
  60 #endif
  61
  62 /**
  63  * @def CHIP_CONFIG_EVENT_LOGGING_DEFAULT_IMPORTANCE
  64  *
  65  * @brief
  66  *   The default importance of events to be logged.  It is used
  67  *   to initialize the chip LoggingConfiguration.
  68  */
  69 #ifndef CHIP_CONFIG_EVENT_LOGGING_DEFAULT_IMPORTANCE
  70 #define CHIP_CONFIG_EVENT_LOGGING_DEFAULT_IMPORTANCE chip::Profiles::DataManagement::Production
  71 #endif
  72
  73 /**
  74  * @def CHIP_CONFIG_EVENT_LOGGING_UTC_TIMESTAMPS
  75  *
  76  * @brief
  77  *   By default, don't record UTC timestamps.
  78  */
  79 #ifndef CHIP_CONFIG_EVENT_LOGGING_UTC_TIMESTAMPS
  80 #define CHIP_CONFIG_EVENT_LOGGING_UTC_TIMESTAMPS 0
  81 #endif
  82
  83 /**
  84  * @def CHIP_CONFIG_EVENT_LOGGING_EXTERNAL_EVENT_SUPPORT
  85  *
  86  * @brief
  87  *   Enable or disable support for externally managed event storage
  88  */
  89 #ifndef CHIP_CONFIG_EVENT_LOGGING_EXTERNAL_EVENT_SUPPORT
  90 #define CHIP_CONFIG_EVENT_LOGGING_EXTERNAL_EVENT_SUPPORT 0
  91 #endif