pjsip_outbound_registrations.c File Reference

Prometheus PJSIP Outbound Registration Metrics. More...

#include "asterisk.h"
#include "asterisk/stasis_message_router.h"
#include "asterisk/stasis_system.h"
#include "asterisk/res_prometheus.h"
#include "asterisk/res_pjsip.h"
#include "prometheus_internal.h"

Include dependency graph for pjsip_outbound_registrations.c:

Go to the source code of this file.

Data Structures
struct	prometheus_metric_wrapper

Functions
static	AST_VECTOR (struct prometheus_metric_wrapper *)
static struct prometheus_metric_wrapper *	get_wrapper (const char *key)
int	pjsip_outbound_registration_metrics_init (void)
	Initialize PJSIP outbound registration metrics. More...
static void	pjsip_outbound_registration_metrics_unload_cb (void)
static void	registration_deleted_observer (const void *obj)
static void	registration_loaded_observer (const char *name, const struct ast_sorcery *sorcery, const char *object_type, int reloaded)
static int	registration_state_to_int (const char *state)
static void	registry_message_cb (void *data, struct stasis_subscription *sub, struct stasis_message *message)

Variables
static ast_mutex_t	metrics_lock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} }
static const struct ast_sorcery_instance_observer	observer_callbacks_registrations
static struct prometheus_metrics_provider	provider
static const struct ast_sorcery_observer	registration_observer
static struct stasis_message_router *	router

Detailed Description

Prometheus PJSIP Outbound Registration Metrics.

Author

Matt Jordan mjord.nosp@m.an@d.nosp@m.igium.nosp@m..com

Definition in file pjsip_outbound_registrations.c.

Function Documentation

AST_VECTOR()

static AST_VECTOR ( struct prometheus_metric_wrapper *  )

static

Definition at line 78 of file pjsip_outbound_registrations.c.

References ast_calloc, ast_copy_string(), prometheus_metric_wrapper::key, and NULL.

{
   struct prometheus_metric_wrapper *wrapper;

   wrapper = ast_calloc(1, sizeof(*wrapper));
   if (!wrapper) {
      return NULL;
   }

   ast_copy_string(wrapper->key, key, sizeof(wrapper->key));
   return wrapper;
}

get_wrapper()

static struct prometheus_metric_wrapper* get_wrapper ( const char *  key )

static

Definition at line 111 of file pjsip_outbound_registrations.c.

References AST_VECTOR_GET, AST_VECTOR_SIZE, prometheus_metric_wrapper::key, lock, metrics_lock, NULL, and SCOPED_MUTEX.

Referenced by registry_message_cb().

{
   int i;
   SCOPED_MUTEX(lock, &metrics_lock);

   for (i = 0; i < AST_VECTOR_SIZE(&metrics); i++) {
      struct prometheus_metric_wrapper *wrapper = AST_VECTOR_GET(&metrics, i);

      if (!strcmp(wrapper->key, key)) {
         return wrapper;
      }
   }

   return NULL;
}

pjsip_outbound_registration_metrics_init()

int pjsip_outbound_registration_metrics_init

(

void

)

Initialize PJSIP outbound registration metrics.

Return values

0	success
-1	error

Definition at line 342 of file pjsip_outbound_registrations.c.

References ao2_cleanup, ast_sip_get_sorcery(), ast_sorcery_instance_observer_add(), ast_sorcery_instance_observer_remove(), ast_sorcery_observer_add(), ast_sorcery_observer_remove(), ast_system_registry_type(), ast_system_topic(), cleanup(), NULL, prometheus_metrics_provider_register(), registry_message_cb(), stasis_message_router_add(), and stasis_message_router_create.

Referenced by load_module().

{
   prometheus_metrics_provider_register(&provider);

#ifdef HAVE_PJPROJECT
   router = stasis_message_router_create(ast_system_topic());
   if (!router) {
      goto cleanup;
   }

   if (stasis_message_router_add(router, ast_system_registry_type(), registry_message_cb, NULL)) {
      goto cleanup;
   }

   if (ast_sorcery_instance_observer_add(ast_sip_get_sorcery(), &observer_callbacks_registrations)) {
      goto cleanup;
   }

   if (ast_sorcery_observer_add(ast_sip_get_sorcery(), "registration", &registration_observer)) {
      goto cleanup;
   }
#endif /* HAVE_PJPROJECT */
   return 0;

#ifdef HAVE_PJPROJECT
cleanup:
   ao2_cleanup(router);
   router = NULL;
   ast_sorcery_instance_observer_remove(ast_sip_get_sorcery(), &observer_callbacks_registrations);
   ast_sorcery_observer_remove(ast_sip_get_sorcery(), "registration", &registration_observer);

   return -1;
#endif /* HAVE_PJPROJECT */
}

pjsip_outbound_registration_metrics_unload_cb()

static void pjsip_outbound_registration_metrics_unload_cb ( void  )

static

Definition at line 323 of file pjsip_outbound_registrations.c.

References ast_sip_get_sorcery(), ast_sorcery_instance_observer_remove(), ast_sorcery_observer_remove(), NULL, and stasis_message_router_unsubscribe_and_join().

{
#ifdef HAVE_PJPROJECT
   stasis_message_router_unsubscribe_and_join(router);
   router = NULL;
   ast_sorcery_instance_observer_remove(ast_sip_get_sorcery(), &observer_callbacks_registrations);
   ast_sorcery_observer_remove(ast_sip_get_sorcery(), "registration", &registration_observer);
#endif /* HAVE_PJPROJECT */
}

registration_deleted_observer()

static void registration_deleted_observer ( const void *  obj )

static

Definition at line 151 of file pjsip_outbound_registrations.c.

References ast_debug, ast_free, ast_sip_get_sorcery(), ast_sorcery_objectset_create, ast_variables_destroy(), AST_VECTOR_GET, AST_VECTOR_REMOVE, AST_VECTOR_SIZE, prometheus_metric_wrapper::key, lock, prometheus_metric_wrapper::metric, metrics_lock, ast_variable::name, ast_variable::next, prometheus_metric_unregister(), SCOPED_MUTEX, and ast_variable::value.

{
   struct ast_variable *fields;
   struct ast_variable *it_fields;
   int i;
   SCOPED_MUTEX(lock, &metrics_lock);

   /*
    * Because our object is opaque, we have to do some pretty ... interesting
    * things here to try and figure out what just happened.
    */
   fields = ast_sorcery_objectset_create(ast_sip_get_sorcery(), obj);
   if (!fields) {
      ast_debug(1, "Unable to convert presumed registry object %p to strings; bailing on delete\n", obj);
      return;
   }

   for (it_fields = fields; it_fields; it_fields = it_fields->next) {
      if (strcasecmp(it_fields->name, "client_uri")) {
         continue;
      }

      for (i = 0; i < AST_VECTOR_SIZE(&metrics); i++) {
         struct prometheus_metric_wrapper *wrapper = AST_VECTOR_GET(&metrics, i);

         if (strcmp(wrapper->key, it_fields->value)) {
            continue;
         }

         ast_debug(1, "Registration metric '%s' deleted; purging with prejudice\n", wrapper->key);
         AST_VECTOR_REMOVE(&metrics, i, 1);
         /* This will free the metric as well */
         prometheus_metric_unregister(wrapper->metric);
         ast_free(wrapper);
      }
   }

   ast_variables_destroy(fields);
}

registration_loaded_observer()

static void registration_loaded_observer ( const char *  name, const struct ast_sorcery *  sorcery, const char *  object_type, int  reloaded  )

static

Definition at line 212 of file pjsip_outbound_registrations.c.

References ao2_ref, ast_debug, ast_free, AST_RETRIEVE_FLAG_DEFAULT, ast_sip_get_sorcery(), ast_sorcery_retrieve_by_fields(), AST_VECTOR_GET, AST_VECTOR_REMOVE, AST_VECTOR_SIZE, prometheus_metric_wrapper::key, lock, prometheus_metric_wrapper::metric, metrics_lock, ast_variable::name, NULL, prometheus_metric_unregister(), and SCOPED_MUTEX.

{
   SCOPED_MUTEX(lock, &metrics_lock);
   int i;

   if (!reloaded) {
      /* Meh */
      return;
   }

   if (strcmp(object_type, "registration")) {
      /* Not interested */
      return;
   }

   for (i = 0; i < AST_VECTOR_SIZE(&metrics); i++) {
      struct prometheus_metric_wrapper *wrapper = AST_VECTOR_GET(&metrics, i);
      struct ast_variable search_fields = {
         .name = "client_uri",
         .value = wrapper->key,
         .next = NULL,
      };
      void *obj;

      ast_debug(1, "Checking for the existance of registration metric %s\n", wrapper->key);
      obj = ast_sorcery_retrieve_by_fields(ast_sip_get_sorcery(), object_type, AST_RETRIEVE_FLAG_DEFAULT, &search_fields);
      if (!obj) {
         ast_debug(1, "Registration metric '%s' not found; purging with prejudice\n", wrapper->key);
         AST_VECTOR_REMOVE(&metrics, i, 1);
         /* This will free the metric as well */
         prometheus_metric_unregister(wrapper->metric);
         ast_free(wrapper);
         continue;
      }
      ao2_ref(obj, -1);
   }

}

registration_state_to_int()

static int registration_state_to_int ( const char *  state )

static

Definition at line 135 of file pjsip_outbound_registrations.c.

Referenced by registry_message_cb().

{
   if (!strcasecmp(state, "Registered")) {
      return 1;
   } else if (!strcasecmp(state, "Rejected")) {
      return 2;
   }
   return 0;
}

registry_message_cb()

static void registry_message_cb ( void *  data, struct stasis_subscription *  sub, struct stasis_message *  message  )

static

Definition at line 267 of file pjsip_outbound_registrations.c.

References ast_eid_default, ast_eid_to_str(), ast_free, ast_json_object_get(), ast_json_string_get(), ast_mutex_lock, ast_mutex_unlock, AST_VECTOR_APPEND, channel_type, get_wrapper(), prometheus_metric::help, ast_json_payload::json, prometheus_metric::lock, prometheus_metric_wrapper::metric, prometheus_metric::name, NULL, prometheus_gauge_create(), PROMETHEUS_METRIC_GAUGE, prometheus_metric_register(), PROMETHEUS_METRIC_SET_LABEL, PROMETHEUS_METRIC_STATIC_INITIALIZATION, registration_state_to_int(), stasis_message_data(), and prometheus_metric::value.

Referenced by pjsip_outbound_registration_metrics_init().

{
   struct ast_json_payload *payload = stasis_message_data(message);
   struct ast_json *json = payload->json;
   const char *username = ast_json_string_get(ast_json_object_get(json, "username"));
   const char *status_str = ast_json_string_get(ast_json_object_get(json, "status"));
   const char *domain = ast_json_string_get(ast_json_object_get(json, "domain"));
   const char *channel_type = ast_json_string_get(ast_json_object_get(json, "channeltype"));
   struct prometheus_metric metric = PROMETHEUS_METRIC_STATIC_INITIALIZATION(
      PROMETHEUS_METRIC_GAUGE,
      "asterisk_pjsip_outbound_registration_status",
      "Current registration status. 0=Unregistered; 1=Registered; 2=Rejected.",
      NULL
   );
   struct prometheus_metric_wrapper *wrapper;
   char eid_str[32];

   ast_eid_to_str(eid_str, sizeof(eid_str), &ast_eid_default);

   PROMETHEUS_METRIC_SET_LABEL(&metric, 0, "eid", eid_str);
   PROMETHEUS_METRIC_SET_LABEL(&metric, 1, "username", username);
   PROMETHEUS_METRIC_SET_LABEL(&metric, 2, "domain", domain);
   PROMETHEUS_METRIC_SET_LABEL(&metric, 3, "channel_type", channel_type);
   snprintf(metric.value, sizeof(metric.value), "%d", registration_state_to_int(status_str));

   wrapper = get_wrapper(username);
   if (wrapper) {
      ast_mutex_lock(&wrapper->metric->lock);
      /* Safe */
      strcpy(wrapper->metric->value, metric.value);
      ast_mutex_unlock(&wrapper->metric->lock);
   } else {
      wrapper = create_wrapper(username);
      if (!wrapper) {
         return;
      }

      wrapper->metric = prometheus_gauge_create(metric.name, metric.help);
      if (!wrapper->metric) {
         ast_free(wrapper);
         return;
      }
      *(wrapper->metric) = metric;

      prometheus_metric_register(wrapper->metric);
      AST_VECTOR_APPEND(&metrics, wrapper);
   }
}

Variable Documentation

metrics_lock

ast_mutex_t metrics_lock = { PTHREAD_RECURSIVE_MUTEX_INITIALIZER_NP , NULL, {1, 0} }

static

Definition at line 67 of file pjsip_outbound_registrations.c.

Referenced by get_wrapper(), registration_deleted_observer(), and registration_loaded_observer().

observer_callbacks_registrations

const struct ast_sorcery_instance_observer observer_callbacks_registrations

static

Initial value:

= {
   .object_type_loaded = registration_loaded_observer,
}

Definition at line 251 of file pjsip_outbound_registrations.c.

provider

struct prometheus_metrics_provider provider

static

Initial value:

= {
   .name = "pjsip_outbound_registration",
   .unload_cb = pjsip_outbound_registration_metrics_unload_cb,
}

Definition at line 337 of file pjsip_outbound_registrations.c.

registration_observer

const struct ast_sorcery_observer registration_observer

static

Initial value:

= {
   .deleted = registration_deleted_observer,
}

Definition at line 191 of file pjsip_outbound_registrations.c.

router

struct stasis_message_router* router

static

Definition at line 42 of file pjsip_outbound_registrations.c.

Referenced by cdr_prop_write(), cdr_read(), cdr_write(), forkcdr_exec(), load_module(), publish_app_cdr_message(), router_dispatch(), router_dtor(), stasis_message_router_create_internal(), and unload_module().