Skip to main content

OpenSIPS

Plugin: charts.d.plugin Module: opensips

Overview

Examine OpenSIPS metrics for insights into SIP server operations. Study call rates, error rates, and response times for reliable voice over IP services.

The collector uses the opensipsctl command line utility to gather OpenSIPS metrics.

This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.

Default Behavior

Auto-Detection

The collector will attempt to call opensipsctl along with a default number of parameters, even without any configuration.

Limits

The default configuration for this integration does not impose any limits on data collection.

Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.

Metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

Per OpenSIPS instance

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

MetricDimensionsUnit
opensips.dialogs_activeactive, earlydialogs
opensips.usersregistered, location, contacts, expiresusers
opensips.registraraccepted, rejectedregistrations/s
opensips.transactionsUAS, UACtransactions/s
opensips.core_rcvrequests, repliesqueries/s
opensips.core_fwdrequests, repliesqueries/s
opensips.core_droprequests, repliesqueries/s
opensips.core_errrequests, repliesqueries/s
opensips.core_badbad_URIs_rcvd, unsupported_methods, bad_msg_hdrqueries/s
opensips.tm_repliesreceived, relayed, localreplies/s
opensips.transactions_status2xx, 3xx, 4xx, 5xx, 6xxtransactions/s
opensips.transactions_inuseinusetransactions
opensips.sl_replies1xx, 2xx, 3xx, 4xx, 5xx, 6xx, sent, error, ACKedreplies/s
opensips.dialogsprocessed, expire, faileddialogs/s
opensips.net_waitingUDP, TCPkilobytes
opensips.uri_checkspositive, negativechecks / sec
opensips.tracesrequests, repliestraces / sec
opensips.shmemtotal, used, real_used, max_used, freekilobytes
opensips.shmem_fragmentfragmentsfragments

Alerts

There are no alerts configured by default for this integration.

Setup

Prerequisites

Install charts.d plugin

If using our official native DEB/RPM packages, make sure netdata-plugin-chartsd is installed.

Required software

The collector requires the opensipsctl to be installed.

Configuration

File

The configuration file name for this integration is charts.d/opensips.conf.

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config charts.d/opensips.conf

Options

The config file is sourced by the charts.d plugin. It's a standard bash file.

The following collapsed table contains all the options that can be configured for the opensips collector.

Config options
NameDescriptionDefaultRequired
opensips_optsSpecify 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.False
opensips_cmdIf opensipsctl is not in $PATH, specify it's full path here.False
opensips_timeoutHow long to wait for opensipsctl to respond.False
opensips_update_everyThe data collection frequency. If unset, will inherit the netdata update frequency.False
opensips_priorityThe charts priority on the dashboard.False
opensips_retriesThe number of retries to do in case of failure before disabling the collector.False

Examples

Custom opensipsctl command

Set a custom path to the opensipsctl command

#opensips_opts="fifo get_statistics all"
opensips_cmd=/opt/opensips/bin/opensipsctl
#opensips_timeout=2

# the data collection frequency
# if unset, will inherit the netdata update frequency
#opensips_update_every=5

# the charts priority on the dashboard
#opensips_priority=80000

# the number of retries to do in case of failure
# before disabling the module
#opensips_retries=10

Troubleshooting

Debug Mode

To troubleshoot issues with the opensips collector, run the charts.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/
  • Switch to the netdata user.

    sudo -u netdata -s
  • Run the charts.d.plugin to debug the collector:

    ./charts.d.plugin debug 1 opensips

Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.