View and collect Bookmarks metrics 

Enter a URL to view a standard set of Bookmarks metrics, or use administrative commands to collect metrics for the Bookmarks application and write them to a file. No file check out or server restart is required when using these commands.


Before starting

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

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>/dogear/toolbox/servermetrics

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

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.

Whichever method you use, the results are cached for one hour. If you attempt to collect metrics data again within that hour, the same numbers are displayed because they are read from the cache. After the cache expires and you request metrics data, the database is queried and the numbers are updated.

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


About this task

Metrics with an asterisk (*) were new or updated in Lotus Connections 3.0.

Table 1. Bookmarks metrics

Metric Description
dogear.metric.average.tags Average number of tags per bookmark
dogear.metric.bookmarks Total number of bookmarks (public and private)
dogear.metric.bookmarks.private * Total number of private bookmarks
dogear.metric.bookmarks.public* Total number of public bookmarks
dogear.metric.bookmarks.visited.today* Number of bookmarks which are visited in the past 24 hours
dogear.metric.newbookmarks.lastmonth* Number of bookmarks posted to Bookmarks in the past 30 days
dogear.metric.newbookmarks.lastweek Number of bookmarks posted to Bookmarks in the past 7 days
dogear.metric.newbookmarks.today* Number of bookmarks posted to Bookmarks in the past 24 hours
dogear.metric.newtags.lastweek Number of tags added in the past 7 days
dogear.metric.percent.public.bookmarks Average number of bookmarks for top 10% of users who have bookmarks
dogear.metric.subscriptions Total number of watchlisted items
dogear.metric.tags Total number of tags
dogear.metric.tags.lastweek Number of new (unique) tags added in the past 7 days
dogear.metric.topusers.avg_bookmark Percent of bookmarks that are public
dogear.metric.unique.tags Total number of unique tags
dogear.metric.unique.urls Total number of unique bookmarks
dogear.metric.unique.urls.lastweek* Number of new (unique) bookmarks added in the past 7 days
dogear.metric.unique.urls.lastmonth* Number of new (unique) bookmarks added in the past 30 days
dogear.metric.unique.urls.today* Number of new (unique) bookmarks added in the past 24 hours
dogear.metric.urls.onemoretag Number of bookmarks with at least 1 tag
dogear.metric.users.avg_bookmark Average number of bookmarks per user

Table 2. Metrics for tags

Metric Description
dogear.metric.average.tags Average number of tags per bookmark
dogear.metric.newtags.lastweek Number of tags added in the past 7 days
dogear.metric.tags Total number of tags
dogear.metric.tags.lastweek Number of new (unique) tags added in the past 7 days
dogear.metric.unique.tags Total number of unique tags

Table 3. Metrics for users

Description Metric
dogear.metric.lastlogin.lastmonth Number of users who logged into Bookmarks in the past 30 days
dogear.metric.lastlogin.lastweek Number of users who logged into Bookmarks in the past 7 days
dogear.metric.lastlogin.today Number of users who logged into Bookmarks in the past 24 hours
dogear.metric.users.morethan10bookmarks* Number of users who have more than 10 bookmarks
dogear.metric.users.notified.lastmonth * Number of users who received notifications in the past 30 days
dogear.metric.users.notified.lastweek Number of users who received notifications in the past 7 days
dogear.metric.users.notified.today* Number of users who received notifications in the past 24 hours
dogear.metric.users.notify.lastweek Number of users who sent notifications in the past 7 days
dogear.metric.users.notlogin90days* Number of users who have not logged into Bookmarks for 90 days
dogear.metric.users.submitbookmarks.lastweek Number of users who posted bookmarks in the past 7 days
dogear.metric.users.subscriptions Number of users with watchlists
dogear.metric.users.w_bookmark Number of users with at least one bookmark

Table 4. Metrics for popular data

Metric Description
dogear.metric.bookmarks.mostpopular* 5 most popular bookmarks in all time
dogear.metric.tags.mostpopularin30days * 5 most popular tags in the past 30 days

Follow these steps to use wsadmin commands for managing metrics:


Procedure

  1. Start the wsadmin client from the following directory of the system on which you installed the deployment manager: <WAS_HOME>\profiles\<DMGR>\bin.

      You must start the client from this directory or subsequent commands that you enter do not execute correctly. For details, see Starting the wsadmin client.

  2. Start the Bookmarks Jython script interpreter by entering the following command: 

      execfile("dogearAdmin.py")

  3. Enter one of the following commands to collect the current metrics:

    • To collect all of the metrics at once, and have them returned as a hashtable: 

        DogearMetricsService.fetchMetrics()

    • To collect one or a subset of metrics: 

        DogearMetricsService.fetchMetric("<metric_to_fetch>")

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

        For example: 

        DogearMetricsService.fetchMetric("dogear.metric.bookmarks") 
DogearMetricsService.fetchMetric("dogear.metric.tags")   
DogearMetricsService.fetchMetric("dogear.metric.unique.tags")   
DogearMetricsService.fetchMetric("dogear.metric.average.tags")   
DogearMetricsService.fetchMetric("dogear.metric.subscriptions") 
DogearMetricsService.fetchMetric("dogear.metric.users.subscriptions")

  4. Use one of the following commands to write the current metrics.

    • To write all of the metrics to a file: 

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

    • where you provide values for the following variables:

      • <file_name> – Full path to a text file in which to store the metric information. If the file does not exist, one will be created. 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.

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

        DogearMetricsService.saveMetricToFile(“C:/ibm/LotusConnections/Data/
   Bookmarks/AppSrv01_server1/metrics/AllDogs.csv”, 40, “all”)

    • To write one metric to a file: 

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

    • where you provide values for the following variables:

      • <file_name> – Full path to a text file in which to store the metric information. If the file does not exist, one will be created. 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.

      • <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> – Metric that you want to write to the file. See the metrics table above for a list of options.

          For example: 

          DogearMetricsService.saveMetricToFile
   (“C:/Connections/metrics/AllDogs.csv”,40,“all”)
DogearMetricsService.saveMetricToFile
   (“C:/Connections/metrics/MetricLnks.csv”,40,“dogear.metric.bookmarks”)
DogearMetricsService.saveMetricToFile
   (“C:/Connections/metrics/MetricTags.csv”,40, “dogear.metric.tags”)
DogearMetricsService.saveMetricToFile
   (“C:/Connections/metrics/UniqueTags.csv”,40,“dogear.metric.unique.tags”)
DogearMetricsService.saveMetricToFile
   (“C:/Connections/metrics/AvgTags.csv”,40,“dogear.metric.average.tags”)
DogearMetricsService.saveMetricToFile
   (“C:/Connections/metrics/Subscripts.csv”,40,“dogear.metric.subscriptions”)
DogearMetricsService.saveMetricToFile
   (“C:/Connections/metrics/UsrSubscrpts.csv”,40,“dogear.metric.users.subscriptions”)

    • 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("dogear.metric.bookmarks")
fldkeys.add("dogear.metric.tags") 
fldkeys.add("dogear.metric.unique.tags")

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

          DogearMetricsService.saveMetricsToFile(“C:/Connections/metrics/MetricLnks.csv”,40,fldkeys)


Parent topic

Administer Bookmarks

Related concepts
Collecting metrics


   

 

});

+

Search Tips   |   Advanced Search