Help_Topics

Widget

The Webmetrics Widget is a simple and flexible reporting tool that allows customers to share performance information.
Widgets update every five minutes, showing the recent availability and performance of a monitored service (website, web application, or web service).

You can embed the Webmetrics Widget into any HTML page: for example, a Customer Support page to share with customers, or a Current Status page for shareholders.

Windows Vista users can also add the Widget as a gadget to the Windows Sidebar.

For example, here is a widget showing Amazon's Elastic Cloud:

Jump to:

Add the Widget to your website

  1. From the Dashboard or Services tab, click the name of the service to which you want to add the Widget.
  2. Open the Widget subtab for your service. The Widget Parameters window appears.
  3. Enter up to 13 characters in the Short Service Name box (for example, EC2Describe).
  4. Enter up to 20 characters in the Name of Service Provider box (for example, Amazon).
  5. Select the Include in Webmetrics Widget Directory check the box to be included in the Webmetrics Widget Directory, which is a list of publicly available Widgets.
  6. Enter text in the Detailed description of this monitoring service.
  7. Click .
  8. The Widget Code pop-up window appears with the HTML code snippet. Copy and paste this snippet into your web page to display the performance of your service over the last 10 intervals.

NOTE: If you change the name of the your service or your login name, the Widget ID will change. You will need to get the new code and re-embed it into your site.

Enable/Disable the Widget

By default, when you create a widget, the widget is active.

  1. Clear the Enable Widget check box and click Update Settings to disable the widget.
  2. Select the Enable Widget check box and click Update Settings to reactivate the widget.

NOTE: A disabled widget remains on your site, but does not update its status. You will need to remove the code on your page to delete the widget.

Modify the size of your Widget

  • Once you have the HTML snippet of Widget code, you can change the size of the Widget by modifying the parameters in the widget code.
    var so = new SWFObject("http://storage.webmetrics.com/widget/widget.swf", "widget", "WIDTH_PARAMETER", "HEIGHT_PARAMETER", "8");
  • Example - to set the Widget size to be 200 by 200 pixels:
    var so = new SWFObject("http://storage.webmetrics.com/widget/widget.swf", "widget", "200", "200", "8");
    • It is recommended to make the Widget square - with the same height and width dimensions - for best presentation.

NOTE: It is strongly recommended that you do not modify the Widget code other than changing the height and width parameters as described above. Any modifications are likely to mean that the Widget will not function correctly.

Correct any errors in your Widget code

  1. Repeat steps 1 and 2 in the Add the Widget to your website procedure above.
  2. Click to display the new Widget code.

Add Webmetrics Widget as a gadget into Vista's Sidebar

  1. On your local PC, click Start, then Run.
  2. At the prompt, paste this text into the text box: %userprofile%\appdata\local\microsoft\windows sidebar\gadgets
  3. Click Run. The Gadgets folder opens.
  4. Create a new folder called {{WebmetricsWidget.gadget}}in the Gadgets folder.
  5. Add these three files to this folder (right click on the links and save it to the WebmetricsWidget.gadget directory):
  6. Open the Widget.htm file using an appropriate editor (e.g., Notepad) and replace the code indicated with your Widget code snippet.
  7. Save your changes to Widget.htm. You are now ready to add the Webmetrics Widget to your Vista Sidebar.
  8. Make sure Sidebar is running. If it is not, click Start > All Programs > Accessories > Windows Sidebar.
  9. In Sidebar, right-click on an empty area of your Sidebar and select Add Gadgets or click the icon located at the top of the Sidebar. The Add Widget dialog box opens.
  10. Select the Webmetrics Widget (it should appear as a graph plot) and drag it to your Sidebar.

Your widget is now in your Sidebar, constantly displaying the performance of your chosen service.

Additional Notes:

  • Please note that if you wish to have more than one Webmetrics Widget in your Vista Sidebar, then you should create multiple directories, one for each Widget, similar to the following:
    • WebmetricsWidget1.gadget
    • WebmetricsWidget2.gadget
    • WebmetricsWidget3.gadget
      NOTE: Widgets are not currently supported on 64-bit versions of Vista.

See also

Access_the_Real_Time_Console