Home

 

View and collect Wikis metrics

Use the WikisMetricsService commands to monitor operations, product usage, and to make configuration adjustments when necessary.

Metrics are frequency data that are recorded about the database state. Unlike other IBM Lotus Connections features, Files and Wikis have a task to record metrics data nightly and store it in the Stat table. The Stat table isolates data by day (one row per day) and by “type.” A feature can have multiple types, for example Files has a community files and personal files type. Some data (for example, user counts) is the same for both of these types, but most of the other data (for example, library sizes) is particular to that set of data. There are two ways to view and collect metrics. The simplest way is to enter the following URL and view some of the most relevant metrics available for the feature:

where <servername.com:port> is the appropriate host name and port number for your server.

Use administrative commands to return metrics. No file check out or server restart is required when using these commands.

  1. Open a command window and start the wsadmin command line tool as described in the topic, Starting the wsadmin client.

  2. Start the Wikis script with the following command:

  3. Network deployment:

      execfile("profile_root/config/bin_lc_admin/ wikisAdmin.py")
      

  4. Use the commands below to retrieve metrics.


    WikisMetricsService administrative commands

    Command Description

    WikisMetricsService.browse(string startDate, string endDate, string filePathWithFilterKeys)

    Returns metrics about wikis stored in the database. The same metrics are provided for each day in a specified period. Parameters:

      startDate

      The start date for the period, in YYYY-MM-DD format.

      endDate

      The end date for the period, in YYYY-MM-DD format.

      filePathWithFilterKeys

      The full path to a text file in which each line contains a statistical key. If you specify a file, only metrics listed in the file are returned. If you do not specify a file, all data is returned.

    See the topic Wikis metrics for metrics and their descriptions.

    If you do not specify dates, then the command uses the first available day with data for startDate, and the last available day with data for endDate.

    WikisMetricsService.saveToFile(string filePath, string startDate, string endDate, string filePathWithFilterKeys, string append)

    Returns metrics about wikis stored in the database, and then stores them in a local file. The same metrics are provided for each day in a specified period. Parameters:

      filePath

      Path to a file in which to store the metrics. metrics are stored in comma-separated value (CSV) format.

      startDate

      The start date for the period, in YYYY-MM-DD format.

      endDate

      The end date for the period, in YYYY-MM-DD format.

      filePathWithFilterKeys

      The full path to a text file in which each line contains a key. If you specify a file, only metrics mapped to keys listed in the file are returned. If you do not specify a file, all data is returned.

      append

      string whose default value is

      "true"

      Change to

      "false"

      to have the command overwrite the existing file instead of appending the data in the existing file.

    See the topic Wikis metrics for metrics and their descriptions.

    If you do not specify dates, then the command uses the first available day with data for startDate, and the last available day with data for endDate.

    WikisMetricsService.getAvailableRange

    Returns a string array where the first element is the first day data is available and the second element is the last day that data is available for wiki libraries. Typically, the current day's data is not available until 12:01 A.M. the following day.

    If metrics collection was disabled or did not occur because of some issue, there may be gaps in data available.


Administer Wikis

Collect metrics

 

Related tasks

Start the wsadmin client


+

Search Tips   |   Advanced Search