<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `src/monitoring.rs`."><title>monitoring.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-b7b9f40b.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="scrapfly_sdk" data-themes="" data-resource-suffix="" data-rustdoc-version="1.95.0 (59807616e 2026-04-14)" data-channel="1.95.0" data-search-js="search-63369b7b.js" data-stringdex-js="stringdex-b897f86f.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-5013f961.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><h1><div class="sub-heading">scrapfly_sdk/</div>monitoring.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Monitoring API — aggregated + per-target metrics.
<a href=#2 id=2 data-nosnippet>2</a>//!
<a href=#3 id=3 data-nosnippet>3</a>//! Wraps `GET /scrape/monitoring/metrics` and
<a href=#4 id=4 data-nosnippet>4</a>//! `GET /scrape/monitoring/metrics/target`. Enterprise plan only.
<a href=#5 id=5 data-nosnippet>5</a>//! See <https://scrapfly.io/docs/monitoring#api>.
<a href=#6 id=6 data-nosnippet>6</a>
<a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">use </span>serde::{Deserialize, Serialize};
<a href=#8 id=8 data-nosnippet>8</a>
<a href=#9 id=9 data-nosnippet>9</a><span class="doccomment">/// Response format for the Monitoring API.
<a href=#10 id=10 data-nosnippet>10</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
<a href=#11 id=11 data-nosnippet>11</a>#[serde(rename_all = <span class="string">"lowercase"</span>)]
<a href=#12 id=12 data-nosnippet>12</a></span><span class="kw">pub enum </span>MonitoringDataFormat {
<a href=#13 id=13 data-nosnippet>13</a> <span class="doccomment">/// Structured JSON aggregates (default).
<a href=#14 id=14 data-nosnippet>14</a> </span>Structured,
<a href=#15 id=15 data-nosnippet>15</a> <span class="doccomment">/// Prometheus text exposition.
<a href=#16 id=16 data-nosnippet>16</a> </span>Prometheus,
<a href=#17 id=17 data-nosnippet>17</a>}
<a href=#18 id=18 data-nosnippet>18</a>
<a href=#19 id=19 data-nosnippet>19</a><span class="kw">impl </span>MonitoringDataFormat {
<a href=#20 id=20 data-nosnippet>20</a> <span class="doccomment">/// Wire-format string.
<a href=#21 id=21 data-nosnippet>21</a> </span><span class="kw">pub fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>str {
<a href=#22 id=22 data-nosnippet>22</a> <span class="kw">match </span><span class="self">self </span>{
<a href=#23 id=23 data-nosnippet>23</a> <span class="self">Self</span>::Structured => <span class="string">"structured"</span>,
<a href=#24 id=24 data-nosnippet>24</a> <span class="self">Self</span>::Prometheus => <span class="string">"prometheus"</span>,
<a href=#25 id=25 data-nosnippet>25</a> }
<a href=#26 id=26 data-nosnippet>26</a> }
<a href=#27 id=27 data-nosnippet>27</a>}
<a href=#28 id=28 data-nosnippet>28</a>
<a href=#29 id=29 data-nosnippet>29</a><span class="doccomment">/// Pre-defined monitoring time window.
<a href=#30 id=30 data-nosnippet>30</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
<a href=#31 id=31 data-nosnippet>31</a></span><span class="kw">pub enum </span>MonitoringPeriod {
<a href=#32 id=32 data-nosnippet>32</a> <span class="doccomment">/// Last 5 minutes.
<a href=#33 id=33 data-nosnippet>33</a> </span><span class="attr">#[serde(rename = <span class="string">"last5m"</span>)]
<a href=#34 id=34 data-nosnippet>34</a> </span>Last5m,
<a href=#35 id=35 data-nosnippet>35</a> <span class="doccomment">/// Last 1 hour.
<a href=#36 id=36 data-nosnippet>36</a> </span><span class="attr">#[serde(rename = <span class="string">"last1h"</span>)]
<a href=#37 id=37 data-nosnippet>37</a> </span>Last1h,
<a href=#38 id=38 data-nosnippet>38</a> <span class="doccomment">/// Last 24 hours.
<a href=#39 id=39 data-nosnippet>39</a> </span><span class="attr">#[serde(rename = <span class="string">"last24h"</span>)]
<a href=#40 id=40 data-nosnippet>40</a> </span>Last24h,
<a href=#41 id=41 data-nosnippet>41</a> <span class="doccomment">/// Last 7 days.
<a href=#42 id=42 data-nosnippet>42</a> </span><span class="attr">#[serde(rename = <span class="string">"last7d"</span>)]
<a href=#43 id=43 data-nosnippet>43</a> </span>Last7d,
<a href=#44 id=44 data-nosnippet>44</a> <span class="doccomment">/// Current subscription period.
<a href=#45 id=45 data-nosnippet>45</a> </span><span class="attr">#[serde(rename = <span class="string">"subscription"</span>)]
<a href=#46 id=46 data-nosnippet>46</a> </span>Subscription,
<a href=#47 id=47 data-nosnippet>47</a>}
<a href=#48 id=48 data-nosnippet>48</a>
<a href=#49 id=49 data-nosnippet>49</a><span class="kw">impl </span>MonitoringPeriod {
<a href=#50 id=50 data-nosnippet>50</a> <span class="doccomment">/// Wire-format string.
<a href=#51 id=51 data-nosnippet>51</a> </span><span class="kw">pub fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>str {
<a href=#52 id=52 data-nosnippet>52</a> <span class="kw">match </span><span class="self">self </span>{
<a href=#53 id=53 data-nosnippet>53</a> <span class="self">Self</span>::Last5m => <span class="string">"last5m"</span>,
<a href=#54 id=54 data-nosnippet>54</a> <span class="self">Self</span>::Last1h => <span class="string">"last1h"</span>,
<a href=#55 id=55 data-nosnippet>55</a> <span class="self">Self</span>::Last24h => <span class="string">"last24h"</span>,
<a href=#56 id=56 data-nosnippet>56</a> <span class="self">Self</span>::Last7d => <span class="string">"last7d"</span>,
<a href=#57 id=57 data-nosnippet>57</a> <span class="self">Self</span>::Subscription => <span class="string">"subscription"</span>,
<a href=#58 id=58 data-nosnippet>58</a> }
<a href=#59 id=59 data-nosnippet>59</a> }
<a href=#60 id=60 data-nosnippet>60</a>}
<a href=#61 id=61 data-nosnippet>61</a>
<a href=#62 id=62 data-nosnippet>62</a><span class="doccomment">/// Aggregation level for `/scrape/monitoring/metrics`.
<a href=#63 id=63 data-nosnippet>63</a></span><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
<a href=#64 id=64 data-nosnippet>64</a>#[serde(rename_all = <span class="string">"lowercase"</span>)]
<a href=#65 id=65 data-nosnippet>65</a></span><span class="kw">pub enum </span>MonitoringAggregation {
<a href=#66 id=66 data-nosnippet>66</a> <span class="doccomment">/// Account-level totals.
<a href=#67 id=67 data-nosnippet>67</a> </span>Account,
<a href=#68 id=68 data-nosnippet>68</a> <span class="doccomment">/// Per-project aggregates.
<a href=#69 id=69 data-nosnippet>69</a> </span>Project,
<a href=#70 id=70 data-nosnippet>70</a> <span class="doccomment">/// Top-100 targets.
<a href=#71 id=71 data-nosnippet>71</a> </span>Target,
<a href=#72 id=72 data-nosnippet>72</a>}
<a href=#73 id=73 data-nosnippet>73</a>
<a href=#74 id=74 data-nosnippet>74</a><span class="kw">impl </span>MonitoringAggregation {
<a href=#75 id=75 data-nosnippet>75</a> <span class="doccomment">/// Wire-format string.
<a href=#76 id=76 data-nosnippet>76</a> </span><span class="kw">pub fn </span>as_str(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'static </span>str {
<a href=#77 id=77 data-nosnippet>77</a> <span class="kw">match </span><span class="self">self </span>{
<a href=#78 id=78 data-nosnippet>78</a> <span class="self">Self</span>::Account => <span class="string">"account"</span>,
<a href=#79 id=79 data-nosnippet>79</a> <span class="self">Self</span>::Project => <span class="string">"project"</span>,
<a href=#80 id=80 data-nosnippet>80</a> <span class="self">Self</span>::Target => <span class="string">"target"</span>,
<a href=#81 id=81 data-nosnippet>81</a> }
<a href=#82 id=82 data-nosnippet>82</a> }
<a href=#83 id=83 data-nosnippet>83</a>}
<a href=#84 id=84 data-nosnippet>84</a>
<a href=#85 id=85 data-nosnippet>85</a><span class="doccomment">/// Options for the request-based metrics endpoints
<a href=#86 id=86 data-nosnippet>86</a>/// (`get_*_monitoring_metrics`).
<a href=#87 id=87 data-nosnippet>87</a></span><span class="attr">#[derive(Debug, Clone, Default)]
<a href=#88 id=88 data-nosnippet>88</a></span><span class="kw">pub struct </span>MonitoringMetricsOptions {
<a href=#89 id=89 data-nosnippet>89</a> <span class="doccomment">/// Response format (default: `Structured`).
<a href=#90 id=90 data-nosnippet>90</a> </span><span class="kw">pub </span>format: <span class="prelude-ty">Option</span><MonitoringDataFormat>,
<a href=#91 id=91 data-nosnippet>91</a> <span class="doccomment">/// Pre-defined time window.
<a href=#92 id=92 data-nosnippet>92</a> </span><span class="kw">pub </span>period: <span class="prelude-ty">Option</span><MonitoringPeriod>,
<a href=#93 id=93 data-nosnippet>93</a> <span class="doccomment">/// Aggregation levels to include (combinable).
<a href=#94 id=94 data-nosnippet>94</a> </span><span class="kw">pub </span>aggregation: <span class="prelude-ty">Option</span><Vec<MonitoringAggregation>>,
<a href=#95 id=95 data-nosnippet>95</a> <span class="doccomment">/// Fold events with `origin=WEBHOOK` (callbacks executed by the
<a href=#96 id=96 data-nosnippet>96</a> /// webhook worker) into this product's totals. Defaults to `false`
<a href=#97 id=97 data-nosnippet>97</a> /// to match the dashboard's default view.
<a href=#98 id=98 data-nosnippet>98</a> </span><span class="kw">pub </span>include_webhook: bool,
<a href=#99 id=99 data-nosnippet>99</a>}
<a href=#100 id=100 data-nosnippet>100</a>
<a href=#101 id=101 data-nosnippet>101</a><span class="doccomment">/// Options for the request-based per-target endpoints
<a href=#102 id=102 data-nosnippet>102</a>/// (`get_*_monitoring_target_metrics`).
<a href=#103 id=103 data-nosnippet>103</a>///
<a href=#104 id=104 data-nosnippet>104</a>/// `start` and `end` are pre-formatted UTC strings in the Scrapfly API
<a href=#105 id=105 data-nosnippet>105</a>/// format `YYYY-MM-DD HH:MM:SS`. They are mutually exclusive with `period`
<a href=#106 id=106 data-nosnippet>106</a>/// and must be provided together.
<a href=#107 id=107 data-nosnippet>107</a></span><span class="attr">#[derive(Debug, Clone)]
<a href=#108 id=108 data-nosnippet>108</a></span><span class="kw">pub struct </span>MonitoringTargetMetricsOptions {
<a href=#109 id=109 data-nosnippet>109</a> <span class="doccomment">/// Target root domain (e.g. `httpbin.dev`). Required.
<a href=#110 id=110 data-nosnippet>110</a> </span><span class="kw">pub </span>domain: String,
<a href=#111 id=111 data-nosnippet>111</a> <span class="doccomment">/// Group subdomains under the root. Defaults to `false`.
<a href=#112 id=112 data-nosnippet>112</a> </span><span class="kw">pub </span>group_subdomain: bool,
<a href=#113 id=113 data-nosnippet>113</a> <span class="doccomment">/// Pre-defined window. Ignored if `start`/`end` are provided.
<a href=#114 id=114 data-nosnippet>114</a> </span><span class="kw">pub </span>period: <span class="prelude-ty">Option</span><MonitoringPeriod>,
<a href=#115 id=115 data-nosnippet>115</a> <span class="doccomment">/// Custom window start (UTC, `YYYY-MM-DD HH:MM:SS`). Must be set with `end`.
<a href=#116 id=116 data-nosnippet>116</a> </span><span class="kw">pub </span>start: <span class="prelude-ty">Option</span><String>,
<a href=#117 id=117 data-nosnippet>117</a> <span class="doccomment">/// Custom window end (UTC, `YYYY-MM-DD HH:MM:SS`). Must be set with `start`.
<a href=#118 id=118 data-nosnippet>118</a> </span><span class="kw">pub </span>end: <span class="prelude-ty">Option</span><String>,
<a href=#119 id=119 data-nosnippet>119</a> <span class="doccomment">/// Fold WEBHOOK origin into this product's totals.
<a href=#120 id=120 data-nosnippet>120</a> </span><span class="kw">pub </span>include_webhook: bool,
<a href=#121 id=121 data-nosnippet>121</a>}
<a href=#122 id=122 data-nosnippet>122</a>
<a href=#123 id=123 data-nosnippet>123</a><span class="kw">impl </span>MonitoringTargetMetricsOptions {
<a href=#124 id=124 data-nosnippet>124</a> <span class="doccomment">/// Convenience constructor: query a single domain with the default
<a href=#125 id=125 data-nosnippet>125</a> /// pre-defined window.
<a href=#126 id=126 data-nosnippet>126</a> </span><span class="kw">pub fn </span>for_domain(domain: <span class="kw">impl </span>Into<String>) -> <span class="self">Self </span>{
<a href=#127 id=127 data-nosnippet>127</a> <span class="self">Self </span>{
<a href=#128 id=128 data-nosnippet>128</a> domain: domain.into(),
<a href=#129 id=129 data-nosnippet>129</a> group_subdomain: <span class="bool-val">false</span>,
<a href=#130 id=130 data-nosnippet>130</a> period: <span class="prelude-val">None</span>,
<a href=#131 id=131 data-nosnippet>131</a> start: <span class="prelude-val">None</span>,
<a href=#132 id=132 data-nosnippet>132</a> end: <span class="prelude-val">None</span>,
<a href=#133 id=133 data-nosnippet>133</a> include_webhook: <span class="bool-val">false</span>,
<a href=#134 id=134 data-nosnippet>134</a> }
<a href=#135 id=135 data-nosnippet>135</a> }
<a href=#136 id=136 data-nosnippet>136</a>}
<a href=#137 id=137 data-nosnippet>137</a>
<a href=#138 id=138 data-nosnippet>138</a><span class="doccomment">/// Options for the Cloud Browser monitoring endpoints. Cloud Browser is
<a href=#139 id=139 data-nosnippet>139</a>/// session-based (one allocation = one long-lived browser, billed by
<a href=#140 id=140 data-nosnippet>140</a>/// runtime + bandwidth) and exposes a distinct shape from the
<a href=#141 id=141 data-nosnippet>141</a>/// request-based products. There is no `domain`/`target` and no
<a href=#142 id=142 data-nosnippet>142</a>/// `include_webhook`.
<a href=#143 id=143 data-nosnippet>143</a></span><span class="attr">#[derive(Debug, Clone, Default)]
<a href=#144 id=144 data-nosnippet>144</a></span><span class="kw">pub struct </span>CloudBrowserMonitoringOptions {
<a href=#145 id=145 data-nosnippet>145</a> <span class="doccomment">/// Pre-defined window. Ignored if `start`/`end` are provided.
<a href=#146 id=146 data-nosnippet>146</a> </span><span class="kw">pub </span>period: <span class="prelude-ty">Option</span><MonitoringPeriod>,
<a href=#147 id=147 data-nosnippet>147</a> <span class="doccomment">/// Optional filter to a single proxy pool (e.g. `public_datacenter_pool`).
<a href=#148 id=148 data-nosnippet>148</a> </span><span class="kw">pub </span>proxy_pool: <span class="prelude-ty">Option</span><String>,
<a href=#149 id=149 data-nosnippet>149</a> <span class="doccomment">/// Custom window start (UTC, `YYYY-MM-DD HH:MM:SS`). Must be set with `end`.
<a href=#150 id=150 data-nosnippet>150</a> </span><span class="kw">pub </span>start: <span class="prelude-ty">Option</span><String>,
<a href=#151 id=151 data-nosnippet>151</a> <span class="doccomment">/// Custom window end (UTC, `YYYY-MM-DD HH:MM:SS`). Must be set with `start`.
<a href=#152 id=152 data-nosnippet>152</a> </span><span class="kw">pub </span>end: <span class="prelude-ty">Option</span><String>,
<a href=#153 id=153 data-nosnippet>153</a>}
</code></pre></div></section></main></body></html>