View and collect Communities metrics 

Use the CommunitiesMetricsService 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>/communities/service/html/servermetrics

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

Notes:

• Administrators can restrict access to metrics by specifying the metrics-reader role. For information, see the topic Roles.

• For performance reasons, the metrics are cached for one hour. Within that hour, if you try to gather metrics using the Metrics URL or the wsadmin command, the metrics numbers remain the same because they are read from the cache. After the cache expires, then the next time you request metrics data, the database is queried for the updated information, and the updated numbers are displayed. The user interface reports an "As of:" time to show when the data was last collected.

You can collect the following metrics for Communities:

Table 1. Communities metrics

Metric	Description
communities.metric.bookmarks*	Total number of bookmarks.
communities.metric.createdCommmunities.24hr*	Total number of communities created in the last 24 hours.
communities.metric.distinct.owners	Number of people who are owners of one or more communities.
communities.metric.distinct.tags*	Number of distinct tag names.
communities.metric.distinct.users	Number of people who are members of one or more communities. This number helps you to determine how many people are regular community members versus owners.
communities.metric.feeds*	Total number of feeds.
communities.metric.login24hr.users	Total number of distinct logged-in users in the last 24 hours.
communities.metric.login30days.users	Total number of distinct logged-in users in the last 30 days.
communities.metric.login7days.users	Total number of distinct logged-in users in the last 7 days.
communities.metric.most.popular.tags*	Most frequently used tags.
communities.metric.private.communities	Number of restricted communities.
communities.metric.public.communities	Number of public communities.
communities.metric.publicinvite.communities	Number of public communities where membership is by invitation only.
communities.metric.tags*	Total number of tag instances.
communities.metric.totals.communities	Number of all communities (public, public invite, and private).

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("communitiesAdmin.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.
   

2. Enter one of the following commands to collect the current metrics.
   

   • To collect all the metrics in a single operation, and have them returned as a hash table:
     CommunitiesMetricsService.fetchMetrics()
     

   • To collect one or a subset of metrics:
     CommunitiesMetricsService.fetchMetric("<metric_to_fetch>")
     

   • where the <metric_to_fetch> is one of the metrics defined in the table above.
     For example:

     CommunitiesMetricsService.fetchMetric("communities.metric.public.communities")
     CommunitiesMetricsService.fetchMetric("communities.metric.publicinvite.communities")
     CommunitiesMetricsService.fetchMetric("communities.metric.private.communities")
     CommunitiesMetricsService.fetchMetric("communities.metric.totals.communities")
     CommunitiesMetricsService.fetchMetric("communities.metric.distinct.owners")
     CommunitiesMetricsService.fetchMetric("communities.metric.distinct.users")
     CommunitiesMetricsService.fetchMetric("communities.metric.login24hr.users")
     CommunitiesMetricsService.fetchMetric("communities.metric.login7days.users")
     CommunitiesMetricsService.fetchMetric("communities.metric.login30days.users")
     CommunitiesMetricsService.fetchMetric("communities.metric.createdCommmunities.24hr")
     CommunitiesMetricsService.fetchMetric("communities.metric.distinct.tags")
     CommunitiesMetricsService.fetchMetric("communities.metric.tags")
     CommunitiesMetricsService.fetchMetric("communities.metric.most.popular.tags")
     CommunitiesMetricsService.fetchMetric("communities.metric.bookmarks")
     CommunitiesMetricsService.fetchMetric("communities.metric.feeds")

     
     

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

   • To write all the metrics to a file:
     CommunitiesMetricsService.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:

       CommunitiesMetricsService.saveMetricToFile(“//9.32.168.90/c$/IBM/LotusConnections/Data/communities/metrics/PubComm.csv”, 40, “communities.metric.public.communities”)

       
       

     • <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:

     CommunitiesMetricsService.saveMetricToFile("C:/IBM/LotusConnections/Data/communities/metrics/AllComms.csv",40,“all”)

     
     

   • To write one metric to a file:
     CommunitiesMetricsService.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:

       CommunitiesMetricsService.saveMetricToFile(“//9.32.168.90/c$/IBM/LotusConnections/Data/communities/metrics/PubComm.csv”, 40, “communities.metric.public.communities”)

       
       

     • <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:

       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/PubComm.csv”, 40, 
       “communities.metric.public.communities”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/PubCommInvite.csv”, 
       40, “communities.metric.publicinvite.communities”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/PrivComm.csv”, 40, 
       “communities.metric.private.communities”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/TotComm.csv”, 40, 
       “communities.metric.totals.communities”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/DistOwn.csv”, 40, 
       “communities.metric.distinct.owners”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/DistUsr.csv”, 40, 
       “communities.metric.distinct.users”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/UsrToday.csv”, 40, 
       “communities.metric.login24hr.users”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/UsrThisWeek.csv”, 
       40, “communities.metric.login7days.users”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/UsrThisMonth.csv”, 
       40, “communities.metric.login30days.users”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/CommCreatedToday.
       csv”, 40, “communities.metric.createdCommmunities.24hr”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics//DistTag.csv”, 40, 
       “communities.metric.distinct.tags”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/TagInst.csv”, 40, 
       “communities.metric.tags”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/PopTag.csv”, 40, 
       “communities.metric.most.popular.tags”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/TotBookmark.csv”, 40, 
       “communities.metric.bookmarks”)
       CommunitiesMetricsService.saveMetricToFile(“C:/IBM/LotusConnections/Data/communities/metrics/TotFeed.csv”, 40, 
       “communities.metric.feeds”)

       
       

   • 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("communities.metric.totals.communities")
        fldkeys.add("communities.metric.distinct.owners")
        fldkeys.add("communities.metric.distinct.users")

        
        

     3. Use the following command to write the subset of metrics to a file:
        
        CommunitiesMetricsService.saveMetricsToFile(“C:/IBM/LotusConnections/Data/communities/metrics/MetList.csv”,60,fldkeys)
        

Parent topic

Administer Communities

Related concepts
Collecting metrics

Related tasks

Importing statistics and metrics into a spreadsheet

Related reference
Roles

   

 

});

+

Search Tips   |   Advanced Search