CountersAction.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 1996-2023 The Squid Software Foundation and contributors
3  *
4  * Squid software is distributed under GPLv2+ license and includes
5  * contributions from numerous individuals and organizations.
6  * Please see the COPYING and CONTRIBUTORS files for details.
7  */
8 
9 /* DEBUG: section 16 Cache Manager API */
10 
11 #ifndef SQUID_SRC_MGR_COUNTERSACTION_H
12 #define SQUID_SRC_MGR_COUNTERSACTION_H
13 
14 #include "mgr/Action.h"
15 
16 namespace Mgr
17 {
18 
20 class CountersActionData
21 {
22 public:
23  CountersActionData();
24  CountersActionData& operator += (const CountersActionData& stats);
25 
26 public:
27  struct timeval sample_time;
28  double client_http_requests;
29  double client_http_hits;
30  double client_http_errors;
31  double client_http_kbytes_in;
32  double client_http_kbytes_out;
33  double client_http_hit_kbytes_out;
34  double server_all_requests;
35  double server_all_errors;
36  double server_all_kbytes_in;
37  double server_all_kbytes_out;
38  double server_http_requests;
39  double server_http_errors;
40  double server_http_kbytes_in;
41  double server_http_kbytes_out;
42  double server_ftp_requests;
43  double server_ftp_errors;
44  double server_ftp_kbytes_in;
45  double server_ftp_kbytes_out;
46  double server_other_requests;
47  double server_other_errors;
48  double server_other_kbytes_in;
49  double server_other_kbytes_out;
50  double icp_pkts_sent;
51  double icp_pkts_recv;
52  double icp_queries_sent;
53  double icp_replies_sent;
54  double icp_queries_recv;
55  double icp_replies_recv;
56  double icp_replies_queued;
57  double icp_query_timeouts;
58  double icp_kbytes_sent;
59  double icp_kbytes_recv;
60  double icp_q_kbytes_sent;
61  double icp_r_kbytes_sent;
62  double icp_q_kbytes_recv;
63  double icp_r_kbytes_recv;
64 #if USE_CACHE_DIGESTS
65  double icp_times_used;
66  double cd_times_used;
67  double cd_msgs_sent;
68  double cd_msgs_recv;
69  double cd_memory;
70  double cd_local_memory;
71  double cd_kbytes_sent;
72  double cd_kbytes_recv;
73 #endif
74  double unlink_requests;
75  double page_faults;
76  double select_loops;
77  double cpu_time;
78  double wall_time;
79  double swap_outs;
80  double swap_ins;
81  double swap_files_cleaned;
82  double aborted_requests;
83  double hitValidationAttempts;
84  double hitValidationRefusalsDueToLocking;
85  double hitValidationRefusalsDueToZeroSize;
86  double hitValidationRefusalsDueToTimeLimit;
87  double hitValidationFailures;
88 };
89 
91 class CountersAction: public Action
92 {
93 protected:
94  CountersAction(const CommandPointer &cmd);
95 
96 public:
97  static Pointer Create(const CommandPointer &cmd);
98  /* Action API */
99  void add(const Action& action) override;
100  void pack(Ipc::TypedMsgHdr& msg) const override;
101  void unpack(const Ipc::TypedMsgHdr& msg) override;
102 
103 protected:
104  /* Action API */
105  void collect() override;
106  void dump(StoreEntry* entry) override;
107 
108 private:
109  CountersActionData data;
110 };
111 
112 } // namespace Mgr
113 
114 #endif /* SQUID_SRC_MGR_COUNTERSACTION_H */
115 
Mgr::CountersAction::Create
static Pointer Create(const CommandPointer &cmd)
Definition: CountersAction.cc:97
Mgr::CountersActionData::operator+=
CountersActionData & operator+=(const CountersActionData &stats)
Definition: CountersAction.cc:28
Mgr::CountersAction::collect
void collect() override
calculate and keep local action-specific information
Definition: CountersAction.cc:116
Mgr::CountersAction::dump
void dump(StoreEntry *entry) override
Definition: CountersAction.cc:123
Mgr::CountersAction::unpack
void unpack(const Ipc::TypedMsgHdr &msg) override
unpack action info from the message received by Coordinator
Definition: CountersAction.cc:138
Mgr::Action::cmd
const CommandPointer cmd
the command that caused this action
Definition: Action.h:90
Mgr::CountersActionData::hitValidationRefusalsDueToTimeLimit
double hitValidationRefusalsDueToTimeLimit
Definition: CountersAction.h:86
Mgr::CountersAction::pack
void pack(Ipc::TypedMsgHdr &msg) const override
pack collected action info into a message to be sent to Coordinator
Definition: CountersAction.cc:131
Mgr::CountersAction::CountersAction
CountersAction(const CommandPointer &cmd)
Definition: CountersAction.cc:102
Mgr::CountersActionData
store traffic and resource counters
Definition: CountersAction.h:20
Mgr::CountersActionData::hitValidationRefusalsDueToZeroSize
double hitValidationRefusalsDueToZeroSize
Definition: CountersAction.h:85
Mgr::CountersActionData::hitValidationRefusalsDueToLocking
double hitValidationRefusalsDueToLocking
Definition: CountersAction.h:84
Mgr::CountersActionData::sample_time
struct timeval sample_time
Definition: CountersAction.h:27
Mgr::CountersAction::data
CountersActionData data
Definition: CountersAction.h:109
Ipc::TypedMsgHdr
struct msghdr with a known type, fixed-size I/O and control buffers
Definition: TypedMsgHdr.h:34
Mgr::CountersAction::add
void add(const Action &action) override
incrementally merge in remote information (of the same action type)
Definition: CountersAction.cc:109
Mgr::CountersAction
implement aggregated 'counters' action
Definition: CountersAction.h:91
Mgr
Cache Manager API.
Definition: Action.h:20

 

Introduction

Documentation

Support

Miscellaneous