├── .gitignore ├── .mailmap ├── AUTHORS ├── COPYING ├── README.md ├── RELEASE.md └── check_sip_call.pl /.gitignore: -------------------------------------------------------------------------------- 1 | ## Editors 2 | .*.sw[op] 3 | *~ 4 | -------------------------------------------------------------------------------- /.mailmap: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /AUTHORS: -------------------------------------------------------------------------------- 1 | Markus Frosch 2 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | check_sip_call 2 | ============== 3 | 4 | Testing a SIP call with Icinga or Nagios. 5 | 6 | The plugin will initiate a SIP call over a registrar or proxy. It expects the 7 | other end to pick up the call and either end the call after a timeout, or when 8 | the other end hangs up. 9 | 10 | ## Requirements and Acknowledgment 11 | 12 | The plugin is based on the Perl module [`Net::SIP`](http://search.cpan.org/search?query=Net%3A%3ASIP&mode=module) 13 | and their examples. 14 | 15 | You will also need [`Monitoring::Plugin`](http://search.cpan.org/search?query=Monitoring%3A%3APlugin&mode=module). 16 | 17 | ## Behavior 18 | 19 | Considered OK: 20 | 21 | * Call is established and hung up by peer 22 | * Call is established and ends after timeout (30 seconds) 23 | * Call is established and no audio is received for 10 seconds 24 | 25 | Considered CRITICAL: 26 | 27 | * Invite fails (incorrect number, rejection, auth, network error) 28 | * Invite times out after 30 seconds 29 | 30 | Currently the plugin does not register with the proxy or registrar, it just 31 | invites a peer (with authentication if necessary). 32 | 33 | ## Arguments 34 | 35 | ``` 36 | Usage: check_sip_call.pl [-v] -F -T 37 | 38 | -?, --usage 39 | Print usage information 40 | -h, --help 41 | Print detailed help screen 42 | -V, --version 43 | Print version information 44 | --extra-opts=[section][@file] 45 | Read options from an ini file. See https://www.monitoring-plugins.org/doc/extra-opts.html 46 | for usage and examples. 47 | -F, --from=SIP-URL 48 | SIP identify your are calling from 49 | -T, --to=SIP-URL 50 | SIP identify your are calling to 51 | -R, --registrar=hostname 52 | SIP registrar you call via 53 | -O, --proxy=hostname 54 | SIP proxy you call via 55 | -U, --username=username 56 | username for authenticating to SIP registrar or proxy 57 | -P, --password=password 58 | password for authenticating to SIP registrar or proxy 59 | -t, --timeout=INTEGER 60 | Seconds before plugin times out (default: 15) 61 | -v, --verbose 62 | Show details for command-line debugging (can repeat up to 3 times) 63 | ``` 64 | 65 | ## Examples 66 | 67 | Simple call without full SIP URLs: 68 | 69 | ``` 70 | ./check_sip_call.pl \ 71 | --username johndoe --password test123 \ 72 | --registrar sip.example.com \ 73 | --to +49911928850 74 | ``` 75 | 76 | Using full URLs: 77 | 78 | ``` 79 | ./check_sip_call.pl \ 80 | --username 123456789 \ 81 | --password test123 \ 82 | --registrar 217.10.79.9:5060 \ 83 | --from sip:123456789@sipgate.de \ 84 | --to sip:0911928850@sipgate.de 85 | ``` 86 | 87 | Output for a timed out invite: 88 | 89 | SIP_CALL CRITICAL - Invite ran into timeout after 15 seconds | elapsed_invite=15.00;;;0;;15 90 | 91 | Output for a rejected call: 92 | 93 | SIP_CALL CRITICAL - Inviting sip:012345678@sip.example.com failed: Failed with error 22 code=486 | elapsed_invite=9.50;;;0;;15 94 | 95 | Output for a successful call: 96 | 97 | SIP_CALL OK - Call successful, finished audio. | elapsed_invite=6.96;;;0;;15 elapsed_talking=10.00;;;0;;15 98 | 99 | Output for a successful, but hangup, call: 100 | 101 | SIP_CALL OK - Call successful, peer hung up. | elapsed_invite=4.73;;;0;;15 elapsed_talking=2.52;;;0;;15 102 | 103 | ## Installation 104 | 105 | On Debian / Ubuntu: 106 | 107 | apt-get install libmonitoring-plugin-perl libnet-sip-perl 108 | cp check_sip_call.pl /usr/lib/nagios/plugin/check_sip_call 109 | chmod 755 /usr/lib/nagios/plugin/check_sip_call 110 | 111 | /usr/lib/nagios/plugin/check_sip_call --help 112 | 113 | ## Known Issues 114 | 115 | Net::SIP wants to establish a IPv6 connection. Workaround: Use IPv4 address 116 | 117 | ## License 118 | 119 | Copyright (C) 2017 NETWAYS GmbH 120 | Markus Frosch 121 | 122 | This program is free software; you can redistribute it and/or modify 123 | it under the terms of the GNU General Public License as published by 124 | the Free Software Foundation; either version 2 of the License, or 125 | (at your option) any later version. 126 | 127 | This program is distributed in the hope that it will be useful, 128 | but WITHOUT ANY WARRANTY; without even the implied warranty of 129 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 130 | GNU General Public License for more details. 131 | 132 | You should have received a copy of the GNU General Public License along 133 | with this program; if not, write to the Free Software Foundation, Inc., 134 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 135 | -------------------------------------------------------------------------------- /RELEASE.md: -------------------------------------------------------------------------------- 1 | # Release Workflow 2 | 3 | Specify the release version. 4 | 5 | ``` 6 | VERSION=0.1.1 7 | ``` 8 | 9 | Update the version in `check_sip_call.pl`. 10 | 11 | ## Authors 12 | 13 | Update the [.mailmap](.mailmap) and [AUTHORS](AUTHORS) files: 14 | 15 | ``` 16 | git checkout master 17 | git log --use-mailmap | grep ^Author: | cut -f2- -d' ' | sort | uniq > AUTHORS 18 | ``` 19 | 20 | ## Git Tag 21 | 22 | Commit these changes to the "master" branch: 23 | 24 | ``` 25 | git commit -v -a -m "Release version $VERSION" 26 | ``` 27 | 28 | Create a signed tag: 29 | 30 | ``` 31 | git tag -s -m "Version $VERSION" "v$VERSION" 32 | ``` 33 | 34 | Push the branch and tag. 35 | 36 | ``` 37 | git push origin master 38 | git push --tags 39 | ``` 40 | 41 | ## GitHub Release 42 | 43 | Create a new release for the newly created Git tag. 44 | https://github.com/NETWAYS/check_sip_call/releases 45 | -------------------------------------------------------------------------------- /check_sip_call.pl: -------------------------------------------------------------------------------- 1 | #!/usr/bin/perl 2 | ######################################################################### 3 | # check_sip_call 4 | ######################################################################### 5 | # Copyright (C) 2017 NETWAYS GmbH 6 | # Markus Frosch 7 | # 8 | # This program is free software; you can redistribute it and/or modify 9 | # it under the terms of the GNU General Public License as published by 10 | # the Free Software Foundation; either version 2 of the License, or 11 | # (at your option) any later version. 12 | # 13 | # This program is distributed in the hope that it will be useful, 14 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | # GNU General Public License for more details. 17 | # 18 | # You should have received a copy of the GNU General Public License along 19 | # with this program; if not, write to the Free Software Foundation, Inc., 20 | # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 21 | ######################################################################### 22 | 23 | use strict; 24 | use warnings; 25 | 26 | eval { 27 | require Monitoring::Plugin; 28 | require Net::SIP; 29 | require Time::HiRes; 30 | 1; 31 | } or do { 32 | print "Missing a dependency: $@\n"; 33 | exit(3); 34 | }; 35 | 36 | use Time::HiRes qw(time); 37 | 38 | my $exited_normally = 0; 39 | my $P; 40 | my $ua; 41 | my $call; 42 | my $invited = 0; 43 | my $in_call = 0; 44 | 45 | # Fall back to unknown when program exits unexpected 46 | sub handle_exit { 47 | if ($call) { 48 | # TODO: this causes weird errors, but it ends the call... 49 | $call->cancel() if ($invited); 50 | $call->bye() if ($in_call); 51 | $call->cleanup; 52 | } 53 | if ($ua) { 54 | $ua->cleanup; 55 | } 56 | return if $exited_normally; 57 | exit(3); 58 | } 59 | END { handle_exit; } 60 | $SIG{INT} = \&handle_exit; 61 | $SIG{TERM} = \&handle_exit; 62 | $SIG{ALRM} = sub { print "Plugin timed out!\n"; handle_exit; }; 63 | 64 | # Handling a normal plugin exit 65 | sub plugin_exit { 66 | $exited_normally = 1; 67 | if ($P) { 68 | return $P->plugin_exit(@_); 69 | } else { 70 | return Monitoring::Plugin::Functions::plugin_exit(@_); 71 | } 72 | } 73 | 74 | # Correcting a SIP address with prefix and domain, if provided 75 | sub fix_sip_address { 76 | my $address = shift; 77 | my $registrar = shift; 78 | $address = 'sip:' . $address unless $address =~ /^sip:/; 79 | $address = $address . '@' . $registrar unless !$registrar or $address =~ /\@/; 80 | return $address; 81 | } 82 | 83 | my $license = "Copyright (C) 2017 NETWAYS GmbH 84 | 85 | This Icinga plugin is free software; you can redistribute it and/or 86 | modify it under the terms of the GNU General Public License as 87 | published by the Free Software Foundation; either version 2 of the 88 | License, or (at your option) any later version. 89 | 90 | Full license at https://www.gnu.org/licenses/gpl2.txt 91 | 92 | This program is distributed in the hope that it will be useful, 93 | but WITHOUT ANY WARRANTY; without even the implied warranty of 94 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 95 | GNU General Public License for more details."; 96 | 97 | $P = Monitoring::Plugin->new( 98 | usage => "Usage: %s [-v] -F -T ", 99 | license => $license, 100 | version => "0.1.1", 101 | ); 102 | $P->add_arg( 103 | spec => 'from|F=s', 104 | help => "-F, --from=SIP-URL\n SIP identify your are calling from", 105 | ); 106 | $P->add_arg( 107 | spec => 'to|T=s', 108 | help => "-T, --to=SIP-URL\n SIP identify your are calling to", 109 | required => 1, 110 | ); 111 | $P->add_arg( 112 | spec => 'registrar|R=s', 113 | help => "-R, --registrar=hostname\n SIP registrar you call via", 114 | ); 115 | $P->add_arg( 116 | spec => 'proxy|O=s', 117 | help => "-O, --proxy=hostname\n SIP proxy you call via", 118 | ); 119 | $P->add_arg( 120 | spec => 'username|P=s', 121 | help => "-U, --username=username\n username for authenticating to SIP registrar or proxy", 122 | ); 123 | $P->add_arg( 124 | spec => 'password|P=s', 125 | help => "-P, --password=password\n password for authenticating to SIP registrar or proxy", 126 | ); 127 | $P->add_arg( 128 | spec => 'expires=s', 129 | help => "--expires=seconds\n Seconds for the register to expire (Default: 300) (Set -1 to disable)", 130 | default => 300, 131 | ); 132 | 133 | $P->getopts; 134 | 135 | # Ensure global timeout, twice the timeout plus buffer 136 | alarm $P->opts->timeout * 2 + 2; 137 | 138 | # handle input values 139 | unless ($P->opts->registrar) { 140 | if ($P->opts->proxy) { 141 | $P->opts->set('registrar', $P->opts->proxy); 142 | } elsif ($P->opts->from and $P->opts->from =~ /\@(.+(:\d+)?)$/) { 143 | $P->opts->set('registrar', $1); 144 | } else { 145 | plugin_exit(3, 'You need to specify --registrar or set user@domain --from!'); 146 | } 147 | } 148 | $P->opts->set('registrar', $P->opts->registrar . ':5060') unless $P->opts->registrar =~ /:\d+$/; 149 | unless ($P->opts->from) { 150 | plugin_exit(3, 'You need to specify --from or --username!') unless $P->opts->username; 151 | $P->opts->set('from', $P->opts->username); 152 | } 153 | $P->opts->set('from', fix_sip_address($P->opts->from, $P->opts->registrar)); 154 | $P->opts->set('to', fix_sip_address($P->opts->to, $P->opts->registrar)); 155 | 156 | # create the user agent 157 | $ua = Net::SIP::Simple->new( 158 | from => $P->opts->from, 159 | $P->opts->registrar ? ( registrar => $P->opts->registrar ) : (), 160 | $P->opts->proxy ? ( outgoing_proxy => $P->opts->proxy ) : (), 161 | $P->opts->password ? ( auth => [$P->opts->username, $P->opts->password] ) : (), 162 | ); 163 | 164 | # Register to the server 165 | if ($P->opts->expires > 0) { 166 | $ua->register(expires => 300); 167 | 168 | plugin_exit(2, sprintf( 169 | 'Register failed %s: %s', 170 | $P->opts->to, 171 | $ua->error 172 | )) if $ua->error; 173 | } 174 | 175 | # setup call 176 | my ($invite_final, $peer_hangup, $stopvar, $timeout_invite, $timeout_call); 177 | my $time_start = time(); 178 | $call = $ua->invite($P->opts->to, 179 | # TODO: echo has been disabled with -1, while testing 180 | # loop hangs when RTP connects and the media is echoed 181 | init_media => $ua->rtp('media_recv_echo', undef, -1), 182 | asymetric_rtp => 1, 183 | recv_bye => \$peer_hangup, 184 | send_bye => \$stopvar, 185 | cb_final => \$invite_final, 186 | ); 187 | 188 | plugin_exit(2, sprintf( 189 | 'Creating call failed %s: %s', 190 | $P->opts->to, 191 | $ua->error 192 | )) unless $call; 193 | $invited = 1; 194 | 195 | # wait for invite to complete 196 | $ua->add_timer($P->opts->timeout, \$timeout_invite); 197 | $ua->loop($P->opts->timeout, \$invite_final, \$timeout_invite); 198 | my $time_invite = time(); 199 | 200 | if ($call->error) { 201 | plugin_exit(2, sprintf( 202 | 'Inviting %s failed: %s | elapsed_invite=%0.2f;;;0;;%d', 203 | $P->opts->to, 204 | $call->error, 205 | $time_invite-$time_start, 206 | $P->opts->timeout 207 | )); 208 | } 209 | 210 | # handle timeout during invite 211 | if ($timeout_invite) { 212 | $stopvar = undef; 213 | $call->cancel(cb_final => \$stopvar); 214 | $ua->loop(5, \$stopvar); 215 | $invited = 0; 216 | plugin_exit(2, sprintf( 217 | 'Invite ran into timeout after %d seconds | elapsed_invite=%0.2f;;;0;;%d', 218 | $P->opts->timeout, 219 | $time_invite-$time_start, 220 | $P->opts->timeout 221 | )); 222 | } 223 | 224 | # call is connected 225 | $invited = 0; 226 | $in_call = 1; 227 | 228 | # run mainloop 229 | $ua->add_timer($P->opts->timeout, \$timeout_call); 230 | while (!$stopvar and !$timeout_call and !$peer_hangup) { 231 | $ua->loop(1, \$timeout_call, \$stopvar, \$peer_hangup); 232 | } 233 | my $time_finished = time(); 234 | 235 | # handling the end of call 236 | my $hangup_reason; 237 | if ($peer_hangup) { 238 | $hangup_reason = 'peer hung up'; 239 | } elsif ($stopvar) { 240 | $hangup_reason = 'finished audio'; 241 | } else { 242 | $hangup_reason = sprintf('stopped call after %d seconds', $P->opts->timeout); 243 | $stopvar = undef; 244 | $call->bye(cb_final => \$stopvar); 245 | $ua->loop(5, \$stopvar); 246 | } 247 | $in_call = 0; 248 | 249 | plugin_exit(0, sprintf( 250 | "Call successful, %s. |" 251 | ." elapsed_invite=%0.2f;;;0;;%d" 252 | ." elapsed_talking=%0.2f;;;0;;%d", 253 | $hangup_reason, 254 | $time_invite-$time_start, 255 | $P->opts->timeout, 256 | $time_finished-$time_invite, 257 | $P->opts->timeout 258 | )); 259 | 260 | # vi: ts=2 sw=2 expandtab : 261 | --------------------------------------------------------------------------------