xdmp:server-status

xdmp:server-status(
   $host-id as xs:unsignedLong,
   $server-id as xs:unsignedLong*
) as element(server-status)*

Summary

Returns the status of an app-server on a host.

Required Privileges

Usage Notes

The structure of the data returned is as follows:

server-id

The server id.

server-name

The server name.

host-id

The unique key of the host

error

The error in processing server status.

server-kind

The kind of application server

enabled

The server is enabled.

port

The server socket bind internet port number.

root

The root document directory pathname.

modules

The ID of the database that contains application modules. If on the file-system, then 0.

database

The ID of the content database when applicable. In some cases, this is a forest ID or a random number (when neither a database ID nor a forest ID is available).

ssl-certificate-template

The certificate template.

last-login

The ID of the last login database.

display-last-login

Whether an appserver should display last-login information.

address

The server socket bind numeric internet address.

backlog

The socket listen backlog.

threads

The current number of active application server threads.

max-threads

The maximum number of application servers threads allowed.

request-timeout

The request socket recv timeout, in seconds.

keep-alive-timeout

The keep-alive socket recv timeout, in seconds.

session-timeout

The session expiration timeout, in seconds.

static-expires

The static content expiration interval, in seconds.

max-time-limit

The upper bound for a request's time limit, in seconds.

default-time-limit

The default time limit for a request, in seconds.

max-inference-size

The upper bound for a request's inference size, in megabytes.

default-inference-size

The default inference size for a request, in megabytes.

collation

The default collation for queries.

multi-version-concurrency-control

distribute-timestamps

authentication

The authentication scheme to use for this server

default-user

The user used as the default user in application level authentication. Using the admin user as the default user is equivalent to turning security off.

privilege

The privilege restricting access to the server.

concurrent-request-limit

The concurrent request limit.

default-xquery-version

An application server's default XQuery language version.

current-time

The current time.

request-statuses

The requests being processed by the server.

This is a complex element with the following element children:

request-status

The request being processed by the server.

This is a complex element with the following element children:

request-id

A unique id for a request.

server-id

The server id.

host-id

The unique key of the host

transaction-id

The unique key of the transaction

canceled

Has this request been canceled.

modules

The ID of the database that contains application modules. If on the file-system, then 0.

database

The ID of the content database when applicable. In some cases, this is a forest ID or a random number (when neither a database ID nor a forest ID is available).

root

The root document directory pathname.

request-kind

The kind of request (for example, invoke, eval).

request-text

The request text.

request-rewritten-text

The rewritten request text.

update

Specifies if this request an update (true for update requests).

start-time

The time the operation started.

time-limit

The request's time limit, in seconds.

max-time-limit

The upper bound for a request's time limit, in seconds.

user

The unique ID of the user executing the request.

client-address

The network address of a client

trigger-depth

The maximum depth of trigger invocation.

expanded-tree-cache-hits

The number of hits on the expanded cache.

expanded-tree-cache-misses

The number of misses on the expanded cache.

request-state

The state of a request

profiling-allowed

Is profiling allowed for this request.

profiling-enabled

Is profiling currently enabled for this request.

debugging-allowed

Is debugging allowed for this request.

debugging-status

The debugging status of the request.

retry-count

The number of retries on the request.

expr-id

The expression id.

where-stopped

Where the request is stopped.

request-rate

The rate of a request (requests/sec).

queue-size

The number of tasks in the server queue.

queue-limit

The maximum number size of the queue.

expanded-tree-cache-hits

The number of hits on the expanded cache.

expanded-tree-cache-misses

The number of misses on the expanded cache.

expanded-tree-cache-hit-rate

The average number of hits on the expanded cache.

expanded-tree-cache-miss-rate

The average number of misses on the expanded cache.

fs-program-cache-hits

The number of hits on the filesystem program cache.

fs-program-cache-misses

The number of misses on the filesystem program cache.

db-program-cache-hits

The number of hits on the database program cache.

db-program-cache-misses

The number of misses on the database program cache.

env-program-cache-hits

The number of hits on the XSLT environment program cache.

env-program-cache-misses

The number of misses on the XSLT environment program cache.

fs-main-module-seq-cache-hits

The number of hits on the filesystem main module sequence cache.

fs-main-module-seq-cache-misses

The number of misses on the filesystem main module sequence cache.

db-main-module-seq-cache-hits

The number of hits on the database main module sequence cache.

db-main-module-seq-cache-misses

The number of misses on the database main module sequence cache.

fs-lib-module-cache-hits

The number of hits on the filesystem library module cache.

fs-lib-module-cache-misses

The number of misses on the filesystem library module cache.

db-lib-module-cache-hits

The number of hits on the database library module cache.

db-lib-module-cache-misses

The number of misses on the database library module cache.

hosts

The host's view of all other hosts in the cluster.

This is a complex element with the following element children:

host

The host connection information.

This is a complex element with the following element children:

host-name

The internet host name.

round-trip-count

The total of round-trip communications between the App Server host and this host. A round trip is the completion of a request sent from the App Server host to another host in the cluster.

round-trip-time

The total time (as xs:dayTimeDuration) to complete the round trips from the App Server to this host.

round-trip-rate

The moving average of the rate to send round trip data, in megabytes per second.

round-trip-load

The moving average of the round-trip load on the server, in seconds per second.

output-sgml-character-entities

The character entities to use during output.

output-encoding

The output encoding of the App Server.

default-error-format

The default error format for protocol errors. One of html,xml,json,compatiable

error-handler

The error handler used, if any.

url-rewriter

The url rewriter used, if any.

request-time

1 minute average of request time for this server.

Example

xdmp:server-status(xdmp:host(),xdmp:server("Admin"))
=>

<server-status xmlns="http://marklogic.com/xdmp/status/server">
  <server-id>4492507232107144149</server-id>
  <server-name>Admin</server-name>
  <host-id>13264574555735898770</host-id>
  <server-kind>http-server</server-kind>
  <port>8009</port>
  <root>Admin\</root>
  <modules>0</modules>
  <database>5496769417926491762</database>
  <ssl-certificate-template>0</ssl-certificate-template>
  <last-login>9823948029384029384</last-login>
  <display-last-login>true</display-last-login>
  <backlog>512</backlog>
  <threads>2</threads>
  <max-threads>32</max-threads>
  <request-timeout>30</request-timeout>
  <keep-alive-timeout>5</keep-alive-timeout>
  <session-timeout>3600</session-timeout>
  <max-time-limit>3600</max-time-limit>
  <default-time-limit>600</default-time-limit>
  <collation>http://marklogic.com/collation/</collation>
  <max-inference-size>500</max-inference-size>
  <default-inference-size>100</default-inference-size>
  <authentication>basic</authentication>
  <default-user>8216129598321388485</default-user>
  <privilege>0</privilege>
  <default-xquery-version>1.0-ml</default-xquery-version>
  <current-time>2007-03-29T14:43:00.819-07:00</current-time>
  <request-statuses>
    <request-status>
      <request-id>15629296310429871822</request-id>
      <server-id>4492507232107144149</server-id>
      <host-id>13264574555735898770</host-id>
      <canceled>false</canceled>
      <modules>0</modules>
      <database>5496769417926491762</database>
      <root>Admin\</root>
      <request-kind>invoke</request-kind>
      <request-text>/cluster-status.xqy</request-text>
      <update>false</update>
      <start-time>2007-03-29T14:42:52.905-07:00</start-time>
      <user>8216129598321388485</user>
      <client-address>127.0.0.1</client-address>
      <trigger-depth>0</trigger-depth>
      <expanded-tree-cache-hits>0</expanded-tree-cache-hits>
      <expanded-tree-cache-misses>0</expanded-tree-cache-misses>
      <request-state>running</request-state>
      <profiling-allowed>false</profiling-allowed>
      <profiling-enabled>false</profiling-enabled>
      <debugging-allowed>false</debugging-allowed>
      <debugging-status>detached</debugging-status>
    </request-status>
  </request-statuses>
  <request-rate>0.0639857</request-rate>
  <expanded-tree-cache-hits>759</expanded-tree-cache-hits>
  <expanded-tree-cache-misses>185</expanded-tree-cache-misses>
  <expanded-tree-cache-hit-rate>0.272918</expanded-tree-cache-hit-rate>
  <expanded-tree-cache-miss-rate>0</expanded-tree-cache-miss-rate>
  <fs-program-cache-hits>9</fs-program-cache-hits>
  <fs-program-cache-misses>40</fs-program-cache-misses>
  <db-program-cache-hits>0</db-program-cache-hits>
  <db-program-cache-misses>0</db-program-cache-misses>
  <env-program-cache-hits>0</env-program-cache-hits>
  <env-program-cache-misses>0</env-program-cache-misses>
  <fs-main-module-seq-cache-hits>0</fs-main-module-seq-cache-hits>
  <fs-main-module-seq-cache-misses>19</fs-main-module-seq-cache-misses>
  <db-main-module-seq-cache-hits>0</db-main-module-seq-cache-hits>
  <db-main-module-seq-cache-misses>0</db-main-module-seq-cache-misses>
  <fs-lib-module-cache-hits>412</fs-lib-module-cache-hits>
  <fs-lib-module-cache-misses>23</fs-lib-module-cache-misses>
  <db-lib-module-cache-hits>0</db-lib-module-cache-hits>
  <db-lib-module-cache-misses>0</db-lib-module-cache-misses>
</server-status>