cloudwatch_sdk_metrics.h

Go to the documentation of this file.

// -------------------------------------------------------------------------------------------
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
// This file is part of the AWS CDI-SDK, licensed under the BSD 2-Clause "Simplified" License.
// License details at: https://github.com/aws/aws-cdi-sdk/blob/mainline/LICENSE
// -------------------------------------------------------------------------------------------
 
 #ifndef CDI_CLOUDWATCH_SDK_METRICS_H__
 #define CDI_CLOUDWATCH_SDK_METRICS_H__
 
#include "cdi_core_api.h"
 
 //*********************************************************************************************************************
 //***************************************** START OF DEFINITIONS AND TYPES ********************************************
 //*********************************************************************************************************************
 
typedef struct CloudWatchSdkMetrics CloudWatchSdkMetrics;
 
typedef struct CloudWatchSdkMetrics* CloudWatchSdkMetricsHandle;
 
typedef struct {
    int delta_num_payloads_transferred;
 
    int delta_num_payloads_dropped;
 
    int delta_num_payloads_late;
 
    uint32_t delta_dropped_connection_count;
 
    uint32_t delta_probe_command_retry_count;
 
    uint64_t delta_num_bytes_transferred;
} CloudWatchCounterBasedDeltas;
 
typedef struct {
    const char* dimension_connection_str;
 
    char dimension_stream_str[CDI_MAX_STREAM_NAME_STRING_LENGTH];
 
    uint64_t timestamp_in_ms_since_epoch;
 
    bool high_resolution;
 
    CloudWatchCounterBasedDeltas count_based_delta_stats;    
    CdiPayloadTimeIntervalStats payload_time_interval_stats; 
 
    bool connected;       
    int cpu_utilization;  
    bool is_receiver;     
} CloudWatchTransferStats;
 
typedef struct {
    const char* dimension_domain_str;
} MetricsGathererConfigData;
 
//*********************************************************************************************************************
//******************************************* START OF PUBLIC FUNCTIONS ***********************************************
//*********************************************************************************************************************
 
#ifdef __cplusplus
extern "C" {
#endif
 
CdiReturnStatus CloudWatchSdkMetricsCreate(const CdiCloudWatchConfigData* config_ptr,
                                           CloudWatchSdkMetricsHandle* ret_handle_ptr);
 
CdiReturnStatus CloudWatchSdkMetricsDestroy(CloudWatchSdkMetricsHandle handle);
 
CdiReturnStatus MetricsGathererCreate(const MetricsGathererConfigData* config_ptr,
                                      CloudWatchSdkMetricsHandle* ret_handle_ptr);
 
CdiReturnStatus MetricsGathererDestroy(CloudWatchSdkMetricsHandle handle);
 
CdiReturnStatus MetricsSend(CloudWatchSdkMetricsHandle handle, const CloudWatchTransferStats* transfer_stats_ptr);
 
#ifdef __cplusplus
}
#endif
 
#endif  // CDI_CLOUDWATCH_SDK_METRICS_H__