View and collect Profiles metrics 

Use the ProfilesMetricsService commands and Server Metrics page to monitor product usage, and to make configuration adjustments when necessary.


Before starting

To use administrative commands, use the wsadmin client. See Starting the wsadmin client for details.


About this task

Metrics are frequency data that are recorded about the database state. There are two ways to view and collect metrics. The simplest way is to enter the URL below or select Server Metrics from the site footer to see some of the most relevant metrics available for the application:

http://<servername.com:port>/profiles/html/servermetrics.do

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

Notes:

You can collect the following metrics for Profiles:

Table 1. Profiles metrics

Metric Description
profiles.metric.authenticated.last.7.days Number of employees logged into the Profiles application in the last week
profiles.metric.background.count Number of employees in the Profiles database who have updated their background
profiles.metric.board.comment.count* Number of board posts with comments
profiles.metric.board.count.today* Number of new board posts today
profiles.metric.board.total.count* Number of board posts
profiles.metric.colleague.count.user* Number of users with at least one colleague
profiles.metric.colleague.total.count* Number of colleagues
profiles.metric.employee.count Number of employees in the Profiles database
profiles.metric.links.count* Number of users with links
profiles.metric.picture.count Number of employees in the Profiles database who have supplied a picture
profiles.metric.pronunciation.count Number of employees in the Profiles database who have supplied a pronunciation guide
profiles.metric.tag.profile.count* Number of profiles with tags in the Profiles database
profiles.metric.tag.top.5* Top 5 most popular tags and count in the Profiles database
profiles.metric.tag.total.count* Total number of tags in the Profiles database
profiles.metric.tag.unique.count* Number of unique tags in the Profiles database
profiles.metric.user.board.count* Number of users with at least one board post
profiles.metric.users.authenticated.last.30.days The number of employees logged into the Profiles application in the last month
profiles.metric.users.authenticated.today Number of employees logged into the Profiles application in the last day


Note: The metrics flagged with an asterisk (*) were added in IBM Connections 3.


Procedure

You can also follow these steps to return metrics using administrative commands. No file check out or server restart is required when using these commands.

  1. From the dmgr host:

      cd $DMGR_PROFILE/bin
      ./wsadmin.sh -jython
      execfile("profilesAdmin.py")

      If prompted to specify a service to connect to, type 1 to pick the first node in the list. Most commands can run on any node. If the command writes or reads information to or from a file using a local file path, pick the node where the file is stored.

  • Enter one of the following commands to collect the current metrics:

    • To collect all the metrics at once and have them returned as a hash table:

        ProfilesMetricsService.fetchMetrics()

    • To collect one or a subset of metrics:

        ProfilesMetricsService.fetchMetric("<metric_to_fetch>")

    • where the <metric_to_fetch> is one of the wsadmin metric keys defined in the metrics table above.

        For example:

        ProfilesMetricsService.fetchMetric("profiles.metric.employee.count")
        ProfilesMetricsService.fetchMetric("profiles.metric.background.count")
        ProfilesMetricsService.fetchMetric("profiles.metric.picture.count")
        ProfilesMetricsService.fetchMetric("profiles.metric.total.pronunciation.count")
        ProfilesMetricsService.fetchMetric("profiles.metric.users.authenticated.today")
        ProfilesMetricsService.fetchMetric("profiles.metric.users.authenticated.last.7.days")
        ProfilesMetricsService.fetchMetric("profiles.metric.users.authenticated.last.30.days")

  • Use one of the following commands to write the metrics to a file.

    • To write all the metrics to a file:

        ProfilesMetricsService.saveMetricToFile("<file_name>", <number>,"all")

    • where you provide values for the following variables:

      • <file_name>. Path to a file in which to export the metrics. Metrics are exported in comma separated value (CSV) format. If you specify a file name with a .csv extension, it is possible to open it as a spreadsheet. See Importing statistics and metrics into a spreadsheet.

          Tip: If the metrics are being kept over a period of time, consider using a universal file path so that the command can be run on any node with the metrics saved to the same file. For example:

          ProfilesMetricsService.saveMetricToFile(“//9.32.168.90/c$/IBM/LotusConnections/Data/profiles/metrics/AllProfs.csv”, 40, “all”)

      • <number>. The number of entries to persist in the file. If you specify 20, and add one new entry to the file, the file retains the last 19 entries and adds your new entry. Any older entries are deleted.

    • For example:

        ProfilesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/profiles/metrics/AllProfs.csv”,40,“all”)

    • To write one metric to a file:

        ProfilesMetricsService.saveMetricToFile("<file_name>", <number>,"<metric_to_save>")

    • where you provide values for the following variables:

      • <file_name>. Path to a file in which to export the metrics. Metrics are exported in comma separated value (CSV) format. If you specify a file name with a .csv extension, it is possible to open it as a spreadsheet. See Importing statistics and metrics into a spreadsheet.

          Tip: If the metrics are being kept over a period of time, consider using a universal file path so that the command can be run on any node with the metrics saved to the same file. For example:

          ProfilesMetricsService.saveMetricToFile(“//9.32.168.90/c$/IBM/LotusConnections/Data/profiles/metrics/AllProfs.csv”, 40, “all”)

      • <number>. The number of entries to persist in the file. If you specify 20, and add one new entry to the file, the file retains the last 19 entries and adds your new entry. Any older entries are deleted.

      • <metric_to_save>. The metric that you want to write to the file.

          For example:

          ProfilesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/profiles/metrics/empCnt.csv”,40, 
          “profiles.metric.employee.count”)
          ProfilesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/profiles/metrics/BkGndCnt.csv”,40, 
          “profiles.metric.background.count”)
          ProfilesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/profiles/metrics/PicCnt.csv”,40, 
          “profiles.metric.picture.count”)
          ProfilesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/profiles/metrics/PronunCnt.csv”,40, 
          “profiles.metric.total.pronunciation.count”)
          ProfilesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/profiles/metrics/UsrCntToday.csv”,40, 
          “profiles.metric.users.authenticated.today”)
          ProfilesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/profiles/metrics/UsrCntThisWeek.csv”,
          40, “profiles.metric.users.authenticated.last.7.days”)
          ProfilesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/profiles/metrics/UsrCntThisMonth.csv”,
          40, “profiles.metric.users.authenticated.last.30.days”)

    • To write a subset of metrics to a file:

      1. Define an ArrayList Java™ object variable named fldkeys.

      2. Add the subset of metrics that you want to write to a file to the array. For example:

          from java.util import ArrayList
          fldkeys=ArrayList()
          fldkeys.add("profiles.metric.employee.count")
          fldkeys.add("profiles.metric.background.count")
          fldkeys.add("profiles.metric.picture.count")

      3. Use the following command to write the subset of metrics to a file:

          ProfilesMetricsService.saveMetricsToFile(“C:/IBM/LotusConnections/Data/profiles/metrics/MetList.csv”,60,fldkeys)


    Parent topic

    Monitoring statistics and metrics for Profiles

    Related concepts
    Collecting metrics


    Related tasks


    Importing statistics and metrics into a spreadsheet

    Related reference
    Roles


       

     

    });

    +

    Search Tips   |   Advanced Search