Overview

Packages

  • awl
    • caldav-client-v2
    • RRule
  • davical
    • authentication
      • drivers
    • caldav
    • DAViCalSession
    • DAVTicket
    • external-bind
    • feed
    • HTTPAuthSession
    • iSchedule
    • iSchedule-POST
    • logging
    • metrics
    • Principal
    • propfind
    • PublicSession
    • Request
    • Resource
    • tzservice
  • None

Classes

  • AtomEntry
  • AtomFeed
  • AtomXHTMLContent
  • CalDAVClient
  • CalDAVRequest
  • CalendarInfo
  • CheckResult
  • DAViCalSession
  • DAVPrincipal
  • DAVResource
  • DAVTicket
  • FakeSession
  • HTTPAuthSession
  • imapPamDriver
  • iSchedule
  • ldapDriver
  • Principal
  • PublicSession
  • pwauthPamDriver
  • RepeatRule
  • RepeatRuleDateRange
  • RepeatRuleDateTime
  • RepeatRuleTimeZone
  • Rfc5545Duration
  • rimapPamDriver
  • setupFakeSession
  • squidPamDriver
  • Tools
  • VCard
  • VTimezone
  • WritableCollection

Functions

  • access_ticket_browser
  • add_failure
  • add_proxy_response
  • array_values_mapping
  • auth_functions_deprecated
  • AuthExternalAWL
  • binding_row_editor
  • bindings_to_other_browser
  • bindings_to_us_browser
  • bits_to_privilege
  • build_dependencies_table
  • build_privileges_html
  • build_site_statistics
  • BuildSqlFilter
  • caldav_get_feed
  • calquery_apply_filter
  • cardquery_apply_filter
  • catch_setup_errors
  • check_awl_version
  • check_calendar
  • check_curl
  • check_database_connection
  • check_datetime
  • check_davical_version
  • check_for_expansion
  • check_gettext
  • check_iconv
  • check_ldap
  • check_magic_quotes_gpc
  • check_magic_quotes_runtime
  • check_pdo
  • check_pdo_pgsql
  • check_pgsql
  • check_real_php
  • check_schema_version
  • check_string
  • check_suhosin_server_strip
  • check_xml
  • checkiSchedule
  • collection_privilege_format_function
  • component_to_xml
  • confirm_delete_bind_in
  • confirm_delete_binding
  • confirm_delete_collection
  • confirm_delete_principal
  • confirm_delete_ticket
  • ConstructURL
  • controlRequestContainer
  • create_external
  • CreateDefaultRelationships
  • CreateHomeCalendar
  • CreateHomeCollections
  • DateToISODate
  • DeconstructURL
  • delete_collection
  • deliverItipCancel
  • display_status
  • do_error
  • do_scheduling_for_delete
  • do_scheduling_reply
  • do_scheduling_requests
  • doImipMessage
  • doItipAttendeeReply
  • doItipOrganizerCancel
  • early_catch_fatal_error
  • early_exception_handler
  • edit_binding_row
  • edit_grant_row_collection
  • edit_grant_row_principal
  • edit_group_row
  • edit_ticket_row
  • errorResponse
  • expand_event_instances
  • expand_properties
  • expand_timezone_onsets
  • export_iCalendar
  • fetch_external
  • fix_unique_member
  • generateKeys
  • get_address_properties
  • get_collection_contents
  • get_freebusy
  • get_href_containers
  • get_phpinfo
  • getComponentRange
  • GetItip
  • getPrincipalByID
  • getStaticLdap
  • getStatusMessage
  • GetTZID
  • getUserByEMail
  • getUserByID
  • getUserByName
  • getVCalendarRange
  • grant_row_editor
  • group_members_browser
  • group_memberships_browser
  • group_row_editor
  • handle_cancel_request
  • handle_freebusy_request
  • handle_schedule_reply
  • handle_schedule_request
  • handle_subaction
  • hyperlink
  • i18n
  • IMAP_PAM_check
  • import_addressbook_collection
  • import_calendar_collection
  • import_collection
  • ischedule_cancel
  • ischedule_freebusy_request
  • ischedule_get
  • ischedule_request
  • ISODateToHTTPDate
  • late_catch_fatal_error
  • LDAP_check
  • local_session_sql
  • log_caldav_action
  • log_setup_error
  • logRequestHeaders
  • make_help_link
  • obfuscated_event
  • olson_from_vtimezone
  • principal_collection_browser
  • principal_editor
  • principal_grants_browser
  • principal_privilege_format_function
  • print_metric
  • privilege_to_bits
  • privileges_to_XML
  • process_ace
  • processItipCancel
  • property_response
  • public_events_only
  • PWAUTH_PAM_check
  • rdate_expand
  • RIMAP_check
  • rollback
  • rollback_on_error
  • rrule_expand
  • send_dav_header
  • send_page_header
  • simple_write_resource
  • SqlFilterCardDAV
  • SqlFilterFragment
  • SQUID_PAM_check
  • SRVFormat
  • SRVOk
  • sync_LDAP
  • sync_LDAP_groups
  • sync_user_from_LDAP
  • ticket_row_editor
  • unicodeToUtf8
  • update_external
  • UpdateCollectionTimezones
  • UpdateUserFromExternal
  • utf8ToUnicode
  • write_alarms
  • write_attendees
  • write_resource
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 
<?php
/**
 * DAViCal - metrics page for Prometheus
 *
 * @package   davical
 * @subpackage   metrics
 * @author    Andrew McMillan <andrew@mcmillan.net.nz>
 * @copyright Andrew McMillan <andrew@mcmillan.net.nz>
 * @license   http://gnu.org/copyleft/gpl.html GNU GPL v2 or later
 */

header("Content-type: text/plain; version=0.4.0");

require_once('./always.php');

// If necessary, validate they are coming from an allowed address
if ( isset($c->metrics_collectors) && !in_array($_SERVER['REMOTE_ADDR'], $c->metrics_collectors) ) {
  echo "Nope.";
  exit(0);
}

// If necessary, validate that they are coming in as an authorized user
if ( isset($c->metrics_require_user) ) {
  require_once('HTTPAuthSession.php');
  $session = new HTTPAuthSession();
  if ( $session->username != $c->metrics_require_user ) {
    $session->AuthFailedResponse();
    echo "Nope.";
    exit(0);
  }
}

// Validate that the metrics are actually turned on!
if ( !isset($c->metrics_style) || $c->metrics_style === false ) {
  echo "Metrics are not enabled.";
  exit(0);
}

// Helper function to ensure we get the metric format consistent
function print_metric( $name, $qualifiers, $value ) {
  print $name;
  if ( !empty($qualifiers) ) {
    print '{';
    $continuation = '';
    foreach( $qualifiers AS $k => $v ) {
      if ( $continuation == '' ) {
        $continuation = ',';
      } else {
        print $continuation;
      }
      printf( '%s="%s"', $k, $v);
    }
    print '}';
  }
  echo ' ', $value, "\n";
}


// If they want 'both' or 'all' or something then that's what they will get
// If they don't want counters, they must want to use memcache!
if ( $c->metrics_style != 'counters' ) {
  // These are the preferred metrics, which include some internal details
  // of the request processing.
  include_once('AwlCache.php');
  $cache = getCacheInstance();

  $index = unserialize($cache->get('metrics', 'index'));
  print "# HELP caldav_request_status The DAViCal requests broken down by HTTP method and response status\n";
  print "# TYPE caldav_request_status counter\n";
  foreach( $index['methods'] AS $method => $ignored ) {
    foreach( $index['statuses'] AS $status => $ignored ) {
      $count = $cache->get('metrics', $method.':'.$status );
      if ( $count !== false ) {
        print_metric("caldav_request_status", array('method'=>$method, 'status'=>$status), $count);
      }
    }
  }

  print "\n";
  print "# HELP caldav_response_bytes The DAViCal response size by HTTP method\n";
  print "# TYPE caldav_response_bytes counter\n";
  foreach( $index['methods'] AS $method => $ignored ) {
    $count = $cache->get('metrics', $method.':size');
    print_metric("caldav_request_bytes", array('method'=>$method), $count);
  }

  $timings = array('script', 'query', 'flush');
  print "\n";
  print "# HELP caldav_request_microseconds The DAViCal response time taken in general, in queries, and in flushing buffers\n";
  print "# TYPE caldav_request_microseconds counter\n";
  foreach( $index['methods'] AS $method => $ignored ) {
    foreach( $timings AS $timing ) {
      $count = $cache->get('metrics', $method.':'.$timing.'_time');
      print_metric("caldav_request_microseconds", array('method'=>$method, 'timing'=>$timing), $count);
    }
  }
}

// If they don't want memcache, they must want to use counters!
if ( $c->metrics_style != 'memcache' ) {
  // These are more basic metrics.  Just counts of requests, by type.
  $sql = <<<QUERY
SELECT
  (SELECT last_value FROM metrics_count_get) AS get_count,
  (SELECT last_value FROM metrics_count_put) AS put_count,
  (SELECT last_value FROM metrics_count_propfind) AS propfind_count,
  (SELECT last_value FROM metrics_count_proppatch) AS proppatch_count,
  (SELECT last_value FROM metrics_count_report) AS report_count,
  (SELECT last_value FROM metrics_count_head) AS head_count,
  (SELECT last_value FROM metrics_count_options) AS options_count,
  (SELECT last_value FROM metrics_count_post) AS post_count,
  (SELECT last_value FROM metrics_count_mkcalendar) AS mkcalendar_count,
  (SELECT last_value FROM metrics_count_mkcol) AS mkcol_count,
  (SELECT last_value FROM metrics_count_delete) AS delete_count,
  (SELECT last_value FROM metrics_count_move) AS move_count,
  (SELECT last_value FROM metrics_count_acl) AS acl_count,
  (SELECT last_value FROM metrics_count_lock) AS lock_count,
  (SELECT last_value FROM metrics_count_unlock) AS unlock_count,
  (SELECT last_value FROM metrics_count_mkticket) AS mkticket_count,
  (SELECT last_value FROM metrics_count_delticket) AS delticket_count,
  (SELECT last_value FROM metrics_count_bind) AS bind_count,
  (SELECT last_value FROM metrics_count_unknown) AS unknown_count
QUERY;

  $qry = new AwlQuery($sql);
  $result = $qry->Exec("metrics", __LINE__ , __FILE__);
  $row = (array) $qry->Fetch();
  print "\n";
  print "# HELP caldav_request_count The DAViCal requests broken down by HTTP method (get, put, propfind, etc.).\n";
  print "# TYPE caldav_request_count counter\n";
  foreach ($row as $k => $v) {
    print_metric("caldav_request_count", array( "method" => str_replace("_count", "", $k)), $v);
  }
}

print "\n";
print "# HELP davical_up Are the servers up.\n";
print "# TYPE davical_up gauge\n";
print_metric("davical_up", array('server'=>$c->sysabbr), 1);

if ( function_exists('memory_get_usage') ) {
  print "\n";
  print "# HELP davical_process_memory How much memory is this process using.\n";
  print "# TYPE davical_process_memory gauge\n";
  print_metric("davical_process_memory", array("pid" => getmypid(), 'type' => 'curr'), memory_get_usage());
  print_metric("davical_process_memory", array("pid" => getmypid(), 'type' => 'peak'), memory_get_peak_usage());
}
DAViCal API documentation generated by ApiGen