Statistics

SMS Gateway Statistics

The SMS Gateway service provides the following core statistics:

Field Type Description
n2jslee.smsgw.input_received_redis Counter Tracks the number of inbound Redis messages received.
n2jslee.smsgw.input_received_unsupported Counter Tracks the number of unsupported inbound messages (of all types) received.
n2jslee.smsgw.input_received_redis_unsupported Counter Tracks the number of unsupported inbound Redis messages received.
n2jslee.smsgw.input_received_redis_unparseable Counter Tracks the number of unsupported inbound Redis messages received.
n2jslee.smsgw.input_received_redis_undeliverable_input Counter Tracks the number of undeliverable (due to input parameters) inbound Redis messages received.
n2jslee.smsgw.input_received_redis_undeliverable_failure Counter Tracks the number of undeliverable (due to failure in processing) inbound Redis messages received.
n2jslee.smsgw.input_received_smpp Counter Tracks the number of inbound SMPP messages received.
n2jslee.smsgw.input_received_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts received.
n2jslee.smsgw.input_received_smpp_unsupported Counter Tracks the number of unsupported inbound SMPP messages received.
n2jslee.smsgw.input_received_smpp_delivery_receipt_invalid Counter Tracks the number of invalid inbound SMPP delivery receipts received.
n2jslee.smsgw.cache_retrieved_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts successfully correlated to a stored document (from cache).
n2jslee.smsgw.cache_missed_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts where a stored document was not found (from cache).
n2jslee.smsgw.cache_failed_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts where an unexpected failure occurred retrieving or processing a stored document (from cache).
n2jslee.smsgw.input_persistent_retrieved_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts successfully correlated to a stored document (from persistent storage).
n2jslee.smsgw.input_persistent_failed_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts where an unexpected failure occurred retrieving or processing a stored document (from persistent storage).
n2jslee.smsgw.input_missed_retrieved_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts where a stored document was not found (from persistent storage).
n2jslee.smsgw.input_correlated_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts successfully correlated with a stored document.
n2jslee.smsgw.input_failed_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts not successfully processed after stored document correlation.
n2jslee.smsgw.input_stored_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts with correlation documents successfully stored after update.
n2jslee.smsgw.input_unstored_smpp_delivery_receipt Counter Tracks the number of inbound SMPP delivery receipts with correlation documents not successfully stored after update.
n2jslee.smsgw.input_removed_correlation Counter Tracks the number of correlation documents successfully removed after receipt completion.
n2jslee.smsgw.input_unremoved_correlation Counter Tracks the number of correlation documents not successfully removed after receipt completion.
n2jslee.smsgw.input_processed_redis_storage_failure Counter Tracks the number of inbound Redis messages successfully on-sent but not stored successfully (in whole or in part).
n2jslee.smsgw.input_processed_redis_success Counter Tracks the number of inbound Redis messages successfully on-sent and stored.
n2jslee.smsgw.route_skipped_unsupported Counter Tracks the number of output routes skipped (due to unsupported destination type).
n2jslee.smsgw.route_complete_delivery_failure Counter Tracks the number of output routes completed unsuccessfully (at least one delivery failure).
n2jslee.smsgw.route_complete_success Counter Tracks the number of output routes completed successfully.
n2jslee.smsgw.output_sent_smpp_rejected Counter Tracks the number of SMPP messages sent for delivery unsuccessfully (due to network rejection).
n2jslee.smsgw.output_sent_smpp_failure Counter Tracks the number of SMPP messages sent for delivery unsuccessfully (due to failure in processing).
n2jslee.smsgw.output_sent_smpp_success Counter Tracks the number of SMPP messages sent for delivery successfully.
n2jslee.smsgw.output_stored_correlation_success Counter Tracks the number of correlation documents stored successfully.
n2jslee.smsgw.output_stored_correlation_failure Counter Tracks the number of correlation documents stored unsuccessfully.
n2jslee.smsgw.input_current Gauge Tracks the number of inbound messages (of all types) currently being processed.
n2jslee.smsgw.input_current_redis Gauge Tracks the number of inbound Redis messages currently being processed.
n2jslee.smsgw.input_current_smpp Gauge Tracks the number of inbound SMPP messages currently being processed.
n2jslee.smsgw.output_current Gauge Tracks the number of outbound messages (of all types) currently being processed.
n2jslee.smsgw.output_current_redis Gauge Tracks the number of outbound Redis messages currently being processed.
n2jslee.smsgw.output_current_smpp Gauge Tracks the number of outbound SMPP messages currently being processed.

Each statistic includes tags to track different subtotals for each above statistic.

General Tags

The following tags are included on every statistic:

Tag Description
node The configured name of the node the service is running on.
service The configured name of the SMS Gateway service.
source_service Used to track the original source service of a message.
source_endpoint Used to track the original source endpoint of a message.

Specific Tags

The following tags are statistic-specific:

Tag Description
input_service Used to track the original input service for the source of an SMS delivery receipt. Included for
  • cache_retrieved_smpp_delivery_receipt
  • input_persistent_retrieved_smpp_delivery_receipt
  • input_correlated_smpp_delivery_receipt
  • input_failed_smpp_delivery_receipt
  • input_stored_smpp_delivery_receipt
  • input_unstored_smpp_delivery_receipt
  • input_removed_correlation
  • input_unremoved_correlation
input_endpoint Used to track the original input endpoint for the source of an SMS delivery receipt. Included for
  • cache_retrieved_smpp_delivery_receipt
  • input_persistent_retrieved_smpp_delivery_receipt
  • input_correlated_smpp_delivery_receipt
  • input_failed_smpp_delivery_receipt
  • input_stored_smpp_delivery_receipt
  • input_unstored_smpp_delivery_receipt
  • input_removed_correlation
  • input_unremoved_correlation
destination_service Used to track the destination service name for SMS delivery. Included for
  • output_sent_smpp_success
  • output_sent_smpp_rejected
  • output_sent_smpp_failure
  • output_stored_correlation_success
  • output_stored_correlation_failure
destination_endpoint Used to track the destination service name for SMS delivery. Included for
  • output_sent_smpp_success
  • output_sent_smpp_rejected
  • output_sent_smpp_failure
  • output_stored_correlation_success
  • output_stored_correlation_failure

Example

Given the following configuration extracts on a server:

{
  "server-name": "jslee",
  "applications": {
    "smsgw": {
      "handler": "nz.co.nsquared.slee.smsgateway.SmsGatewayVerticle",
      "configuration": {
        "correlation": {
          "cache-name": "smsgw",
          "storage-service": "redis",          
          "storage-complete-name": "complete"
        },
        "smpp-encoding-sets": {
          "default": { ... }
        },
        "routes": [
          {
            "source-name": "redis/mno1-queue",
            "source-message-type": "nz.co.nsquared.slee.redis.JSLEERedisResponse",
            "destination-message-type": "nz.co.nsquared.slee.smpp.event.SMPPMessageJsonEvent",
            "destination-addresses": [
              "smpp/mno1-connection"
            ]
          }
        ]
      }
    },
    "redis": {
      "handler": "nz.co.nsquared.slee.redis.RedisVerticle",
      "configuration": {
        "connection": {
          "endpoint": ...
        },
        "endpoints": [
          {
            "name": "mno1-queue",
            "source-list": "mno1-queue",
            "error-list": "mno1-queue-error",
            "delete-after-success": true,
            "processing-address": "smsgw",
            "processing-list": "mno1-queue-processing"
          }
        ]
      }
    },
    "smpp": {
      "handler": "nz.co.nsquared.slee.smpp.SMPPVerticle",
      "configuration": {
        "message-handler": "EventBus",
        "default-endpoint": "mno1-connection",
        "encoding-sets": {
          "default": { ... }
        },
        "endpoints": [
          {
            "name": "mno1-connection",
            "port": 5001,
            "server": true,
            "processing-address": "smsgw",
            "encoding-set": "default"
          }
        ]
      }
    }
  }
}

After startup and the submission and delivery of a single message, this configuration will cause the generation of the following statistics:

n2jslee_smsgw_input_current_smpp{node="jslee",service="smsgw",} 0.0
n2jslee_smsgw_input_stored_smpp_delivery_receipt_total{input_endpoint="mno1-queue",input_service="redis",node="jslee",service="smsgw",source_endpoint="mno1-connection",source_service="smpp",} 1.0
n2jslee_smpp_message_response_queue{endpoint="mno1-connection",node="jslee",service="smpp",} 0.0
n2jslee_smpp_message_requests_sent_total{endpoint="mno1-connection",message="submit_sm",node="jslee",service="smpp",} 1.0
n2jslee_smsgw_output_current{node="jslee",service="smsgw",} 0.0
n2jslee_smsgw_input_removed_correlation_total{input_endpoint="mno1-queue",input_service="redis",node="jslee",service="smsgw",source_endpoint="mno1-connection",source_service="smpp",} 1.0
n2jslee_smsgw_input_processed_redis_success_total{node="jslee",service="smsgw",source_endpoint="mno1-queue",source_service="redis",} 1.0
n2jslee_smpp_message_responses_received_total{endpoint="mno1-connection",message="submit_sm_resp",node="jslee",service="smpp",} 1.0
n2jslee_smsgw_input_current_redis{node="jslee",service="smsgw",} 0.0
n2jslee_smsgw_output_current_redis{node="jslee",service="smsgw",} 0.0
n2jslee_smpp_message_responses_sent_total{endpoint="mno1-connection",message="bind_transceiver_resp",node="jslee",service="smpp",} 1.0
n2jslee_smpp_message_responses_sent_total{endpoint="mno1-connection",message="deliver_sm_resp",node="jslee",service="smpp",} 1.0
n2jslee_smsgw_input_correlated_smpp_delivery_receipt_total{input_endpoint="mno1-queue",input_service="redis",node="jslee",service="smsgw",source_endpoint="mno1-connection",source_service="smpp",} 1.0
n2jslee_smsgw_input_received_smpp_total{node="jslee",service="smsgw",source_endpoint="mno1-connection",source_service="smpp",} 1.0
n2jslee_smpp_message_requests_received_total{endpoint="mno1-connection",message="deliver_sm",node="jslee",service="smpp",} 1.0
n2jslee_smpp_message_requests_received_total{endpoint="mno1-connection",message="bind_transceiver",node="jslee",service="smpp",} 1.0
n2jslee_smsgw_output_current_smpp{node="jslee",service="smsgw",} 0.0
n2jslee_smsgw_route_complete_success_total{node="jslee",service="smsgw",source_endpoint="mno1-queue",source_service="redis",} 1.0
n2jslee_smsgw_input_received_redis_total{node="jslee",service="smsgw",source_endpoint="mno1-queue",source_service="redis",} 1.0
n2jslee_smsgw_output_sent_smpp_success_total{destination_endpoint="mno1-connection",destination_service="smpp",node="jslee",service="smsgw",source_endpoint="mno1-queue",source_service="redis",} 1.0
n2jslee_smsgw_input_current{node="jslee",service="smsgw",} 0.0
n2jslee_smsgw_output_stored_correlation_success_total{destination_endpoint="mno1-connection",destination_service="smpp",node="jslee",service="smsgw",source_endpoint="mno1-queue",source_service="redis",} 1.0
n2jslee_smsgw_input_received_smpp_delivery_receipt_total{node="jslee",service="smsgw",source_endpoint="mno1-connection",source_service="smpp",} 1.0
n2jslee_smsgw_cache_retrieved_smpp_delivery_receipt_total{input_endpoint="mno1-queue",input_service="redis",node="jslee",service="smsgw",source_endpoint="mno1-connection",source_service="smpp",} 1.0
```