| 1 | plugin_name: charts.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | plugin_name: charts.d.plugin |
| 5 | module_name: opensips |
| 6 | monitored_instance: |
| 7 | name: OpenSIPS |
| 8 | link: "https://opensips.org/" |
| 9 | categories: |
| 10 | - data-collection.applications |
| 11 | icon_filename: "opensips.png" |
| 12 | related_resources: |
| 13 | integrations: |
| 14 | list: [] |
| 15 | info_provided_to_referring_integrations: |
| 16 | description: "" |
| 17 | keywords: |
| 18 | - opensips |
| 19 | - sip |
| 20 | - voice |
| 21 | - video |
| 22 | - stream |
| 23 | overview: |
| 24 | data_collection: |
| 25 | metrics_description: "Examine OpenSIPS metrics for insights into SIP server operations. Study call rates, error rates, and response times for reliable voice over IP services." |
| 26 | method_description: "The collector uses the `opensipsctl` command line utility to gather OpenSIPS metrics." |
| 27 | supported_platforms: |
| 28 | include: [] |
| 29 | exclude: [] |
| 30 | multi_instance: true |
| 31 | additional_permissions: |
| 32 | description: "" |
| 33 | default_behavior: |
| 34 | auto_detection: |
| 35 | description: "The collector will attempt to call `opensipsctl` along with a default number of parameters, even without any configuration." |
| 36 | limits: |
| 37 | description: "" |
| 38 | performance_impact: |
| 39 | description: "" |
| 40 | setup: |
| 41 | prerequisites: |
| 42 | list: |
| 43 | - title: "Install charts.d plugin" |
| 44 | description: | |
| 45 | If [using our official native DEB/RPM packages](/packaging/installer/UPDATE.md#determine-which-installation-method-you-used), make sure `netdata-plugin-chartsd` is installed. |
| 46 | - title: "Required software" |
| 47 | description: "The collector requires the `opensipsctl` to be installed." |
| 48 | configuration: |
| 49 | file: |
| 50 | name: charts.d/opensips.conf |
| 51 | options: |
| 52 | description: | |
| 53 | The config file is sourced by the charts.d plugin. It's a standard bash file. |
| 54 | |
| 55 | The following collapsed table contains all the options that can be configured for the opensips collector. |
| 56 | folding: |
| 57 | title: "Config options" |
| 58 | enabled: true |
| 59 | list: |
| 60 | - name: opensips_opts |
| 61 | description: Specify parameters to the `opensipsctl` command. If the default value fails to get global status, set here whatever options are needed to connect to the opensips server. |
| 62 | default_value: "fifo get_statistics all" |
| 63 | required: false |
| 64 | - name: opensips_cmd |
| 65 | description: If `opensipsctl` is not in $PATH, specify it's full path here. |
| 66 | default_value: "" |
| 67 | required: false |
| 68 | - name: opensips_timeout |
| 69 | description: How long to wait for `opensipsctl` to respond. |
| 70 | default_value: 2 |
| 71 | required: false |
| 72 | - name: opensips_update_every |
| 73 | description: The data collection frequency. If unset, will inherit the netdata update frequency. |
| 74 | default_value: 5 |
| 75 | required: false |
| 76 | - name: opensips_priority |
| 77 | description: The charts priority on the dashboard. |
| 78 | default_value: 80000 |
| 79 | required: false |
| 80 | - name: opensips_retries |
| 81 | description: The number of retries to do in case of failure before disabling the collector. |
| 82 | default_value: 10 |
| 83 | required: false |
| 84 | examples: |
| 85 | folding: |
| 86 | enabled: false |
| 87 | title: "Config" |
| 88 | list: |
| 89 | - name: Custom `opensipsctl` command |
| 90 | description: Set a custom path to the `opensipsctl` command |
| 91 | config: | |
| 92 | #opensips_opts="fifo get_statistics all" |
| 93 | opensips_cmd=/opt/opensips/bin/opensipsctl |
| 94 | #opensips_timeout=2 |
| 95 | |
| 96 | # the data collection frequency |
| 97 | # if unset, will inherit the netdata update frequency |
| 98 | #opensips_update_every=5 |
| 99 | |
| 100 | # the charts priority on the dashboard |
| 101 | #opensips_priority=80000 |
| 102 | |
| 103 | # the number of retries to do in case of failure |
| 104 | # before disabling the module |
| 105 | #opensips_retries=10 |
| 106 | troubleshooting: |
| 107 | problems: |
| 108 | list: [] |
| 109 | alerts: [] |
| 110 | metrics: |
| 111 | folding: |
| 112 | title: Metrics |
| 113 | enabled: false |
| 114 | description: "" |
| 115 | availability: [] |
| 116 | scopes: |
| 117 | - name: global |
| 118 | description: "These metrics refer to the entire monitored application." |
| 119 | labels: [] |
| 120 | metrics: |
| 121 | - name: opensips.dialogs_active |
| 122 | description: OpenSIPS Active Dialogs |
| 123 | unit: "dialogs" |
| 124 | chart_type: area |
| 125 | dimensions: |
| 126 | - name: active |
| 127 | - name: early |
| 128 | - name: opensips.users |
| 129 | description: OpenSIPS Users |
| 130 | unit: "users" |
| 131 | chart_type: line |
| 132 | dimensions: |
| 133 | - name: registered |
| 134 | - name: location |
| 135 | - name: contacts |
| 136 | - name: expires |
| 137 | - name: opensips.registrar |
| 138 | description: OpenSIPS Registrar |
| 139 | unit: "registrations/s" |
| 140 | chart_type: line |
| 141 | dimensions: |
| 142 | - name: accepted |
| 143 | - name: rejected |
| 144 | - name: opensips.transactions |
| 145 | description: OpenSIPS Transactions |
| 146 | unit: "transactions/s" |
| 147 | chart_type: line |
| 148 | dimensions: |
| 149 | - name: UAS |
| 150 | - name: UAC |
| 151 | - name: opensips.core_rcv |
| 152 | description: OpenSIPS Core Receives |
| 153 | unit: "queries/s" |
| 154 | chart_type: line |
| 155 | dimensions: |
| 156 | - name: requests |
| 157 | - name: replies |
| 158 | - name: opensips.core_fwd |
| 159 | description: OpenSIPS Core Forwards |
| 160 | unit: "queries/s" |
| 161 | chart_type: line |
| 162 | dimensions: |
| 163 | - name: requests |
| 164 | - name: replies |
| 165 | - name: opensips.core_drop |
| 166 | description: OpenSIPS Core Drops |
| 167 | unit: "queries/s" |
| 168 | chart_type: line |
| 169 | dimensions: |
| 170 | - name: requests |
| 171 | - name: replies |
| 172 | - name: opensips.core_err |
| 173 | description: OpenSIPS Core Errors |
| 174 | unit: "queries/s" |
| 175 | chart_type: line |
| 176 | dimensions: |
| 177 | - name: requests |
| 178 | - name: replies |
| 179 | - name: opensips.core_bad |
| 180 | description: OpenSIPS Core Bad |
| 181 | unit: "queries/s" |
| 182 | chart_type: line |
| 183 | dimensions: |
| 184 | - name: bad_URIs_rcvd |
| 185 | - name: unsupported_methods |
| 186 | - name: bad_msg_hdr |
| 187 | - name: opensips.tm_replies |
| 188 | description: OpenSIPS TM Replies |
| 189 | unit: "replies/s" |
| 190 | chart_type: line |
| 191 | dimensions: |
| 192 | - name: received |
| 193 | - name: relayed |
| 194 | - name: local |
| 195 | - name: opensips.transactions_status |
| 196 | description: OpenSIPS Transactions Status |
| 197 | unit: "transactions/s" |
| 198 | chart_type: line |
| 199 | dimensions: |
| 200 | - name: 2xx |
| 201 | - name: 3xx |
| 202 | - name: 4xx |
| 203 | - name: 5xx |
| 204 | - name: 6xx |
| 205 | - name: opensips.transactions_inuse |
| 206 | description: OpenSIPS InUse Transactions |
| 207 | unit: "transactions" |
| 208 | chart_type: line |
| 209 | dimensions: |
| 210 | - name: inuse |
| 211 | - name: opensips.sl_replies |
| 212 | description: OpenSIPS SL Replies |
| 213 | unit: "replies/s" |
| 214 | chart_type: line |
| 215 | dimensions: |
| 216 | - name: 1xx |
| 217 | - name: 2xx |
| 218 | - name: 3xx |
| 219 | - name: 4xx |
| 220 | - name: 5xx |
| 221 | - name: 6xx |
| 222 | - name: sent |
| 223 | - name: error |
| 224 | - name: ACKed |
| 225 | - name: opensips.dialogs |
| 226 | description: OpenSIPS Dialogs |
| 227 | unit: "dialogs/s" |
| 228 | chart_type: line |
| 229 | dimensions: |
| 230 | - name: processed |
| 231 | - name: expire |
| 232 | - name: failed |
| 233 | - name: opensips.net_waiting |
| 234 | description: OpenSIPS Network Waiting |
| 235 | unit: "kilobytes" |
| 236 | chart_type: line |
| 237 | dimensions: |
| 238 | - name: UDP |
| 239 | - name: TCP |
| 240 | - name: opensips.uri_checks |
| 241 | description: OpenSIPS URI Checks |
| 242 | unit: "checks / sec" |
| 243 | chart_type: line |
| 244 | dimensions: |
| 245 | - name: positive |
| 246 | - name: negative |
| 247 | - name: opensips.traces |
| 248 | description: OpenSIPS Traces |
| 249 | unit: "traces / sec" |
| 250 | chart_type: line |
| 251 | dimensions: |
| 252 | - name: requests |
| 253 | - name: replies |
| 254 | - name: opensips.shmem |
| 255 | description: OpenSIPS Shared Memory |
| 256 | unit: "kilobytes" |
| 257 | chart_type: line |
| 258 | dimensions: |
| 259 | - name: total |
| 260 | - name: used |
| 261 | - name: real_used |
| 262 | - name: max_used |
| 263 | - name: free |
| 264 | - name: opensips.shmem_fragment |
| 265 | description: OpenSIPS Shared Memory Fragmentation |
| 266 | unit: "fragments" |
| 267 | chart_type: line |
| 268 | dimensions: |
| 269 | - name: fragments |