Community

Bluemix logging dashboard Quick Reference

Share this post:

As of May 23rd IBM Bluemix Container Service now provides a native Kubernetes operations experience while removing the burden of maintaining master nodes. Kubernetes itself is based on the Docker engine for managing software images and instantiating containers. Get the details.

In Bluemix, you can use IBM Containers to create and manage multiple instances of an app for optimal load balancing and scalability. To monitor the usage of your apps, you can customize a dashboard to see the data from your containers the way you want to see it. You might create a table to display log information or color code data as a pie chart to get a quick sense of how a particular instance is functioning.

This blog includes a quick reference guide for the Kibana user interface to use as you customize your dashboard. For more detailed examples, see Creating a custom Kibana dashboard.

The Bluemix logging dashboard

Bluemix Logmet Dashboard

  1. Toolbar panel: Save, open, or share your dashboards. By default, the toolbar has a time picker with predefined relative time options and auto-refresh options.
  2. Query panel: Create queries for the indexed database.
  3. Filter panel: Apply filters from queries to narrow search further, which trims the results. By default, time is filtered to the last 24 hours. You can change the time by selecting a new value from time picker in the toolbar.
  4. EVENTS BY TIME: This data histogram panel was added for you inside the Histogram row. By default, the data histogram shows the count for all logs within the time set for the interval (y-axis) over time (x-axis). Click the bars, or click-and-drag, to narrow the time filter.
  5. ALL EVENTS: This table panel was added for you inside the Events row. By default, all logs that match the time filter that is defined in the filter panel are displayed.

Common toolbar and time picker tasks

Toolbar Panel Time picker

  • To refresh the dashboard: Click the icon-referesh Refresh icon.
  • To load additional dashboard files for custom views: Click the icon-load Load icon, then:
    • select any dashboard name that is saved in Elasticsearch, or
    • select an existing dashboard by hovering over Advanced and either
      • clicking Choose File to select a local JSON file or
      • entering a Gist number or URL to another dashboard.
  • To share the dashboard: Click the icon-share Share icon and click in the field to configure a custom URL.
  • To configure dashboard: Click the icon-config Configure icon and the Dashboard settings panel is displayed.
  • To save dashboard: Click the icon-save Save icon, and then either:
    • enter the dashboard name to save it in Elasticsearch, or
    • hover over Advanced and click one of the following options: Home, Reset Home, or Export schema.
  • To go to the saved default dashboard: Click the icon-home Goto saved default icon and the default dashboard loads.
  • To change the time picker option: Click the icon-timepicker Time picker icon and select either a predefined relative time or the auto-refresh options from the list.

Filters

filter

  • To add a filter: Click the icon-add Add icon.
  • To remove the filter: Click the icon-remove Remove icon.
  • To on or off the filter: Select or clear the icon-check Filter check box.
  • The default time filter: Modify the time filter by changing the relative time from the icon-timepicker Time picker drop-down menu in the common toolbar.

Queries

query-panel

  • To add a new query: Click the icon-add Add icon.
  • To remove the query: Click the icon-remove Remove icon.
  • To change the color of query: Click the icon-color Colored label and select the color.
  • Multiple queries: (Query #1, Query #2). Queries can be logical OR and be used to separate visualizations.

Query syntax

The query syntax is based on the Lucene query syntax. Boolean operators, wildcards and field filtering are permitted. Query examples:

Field based query:

      job_index: router_1
      type: router_access_log

Regexp query:

      job_index: router*
      hostName: *ng.bluemix.net

Range query:

      Search for logs with a response_time greater or equal than 120ms: response_time: [120 TO *]
      Search for logs with a response_time greater than 120ms: response_time: {120 TO *}

Boolean query:

      AND, OR, NOT
      Note: These values must be CAPITALIZED.

The ALL EVENTS table panel

Table Panel

  1. Fields list panel: Click the icon-left-arrow Left arrow icon under the panel name.
    • To search for a field name: Enter a filter string in the Type to filter field.
    • To add a field to table: Select a field and that field is added to the table as a separate column.
    • To remove a field from table: Clear the field and the column for that field is removed from the table.
    • To check and analyze each filed data: Click a Field name and one of the following actions to create a query on the data.
      1. Click the icon-find Find event by a field icon to see only the log events that include values for this field.
      2. Click the  icon-find2  Find events icon without this field icon see only the log events that do not include values for this field
      3. Click the Terms drop-down list to create a term and show the data in a  table, bar, or pie chart style.
  2. Field column list: Shows columns for the fields that are selected in the field list panel.
    • To move a column: Click the icon-right Right arrow or the icon-left Left arrow icon next to the column name.
    • To sort a column: Click the column title and, optionally, the  icon-down Down arrow or the  icon-up Up arrow to change the direction of the sort.
  3. Fields Details View: Shows the values for each row in Table, JSON, or Raw format. Complete one of the following actions to create a query on the data.
    • To add a filter to match the field value: Click the icon-find Find event by this field icon. A filter for the field value is created, and the dashboard shows the log information that include that value.
    • To add a filter to not match the field value: Click the icon-find2 Find events without this field icon. A filter for the absence of the value is created, and the dashboard shows the logs that do not include that value.
    • To hide a column: Click the icon-toggle Toggle icon. The field is still displayed in the details view, but it does not display as a column.
  4. Table panel configuration: Provides setting configuration, Elasticsearch query inspection, duplication, moving, and removing tables.
    • To view the Elasticsearch query for a table: Click the icon-inspect Inspect icon to see the last Elasticsearch query.
    • To duplicate a table panel: Click the icon-duplicate Duplicate icon to copy and paste the table.
    • To configure a table panel: Click the icon-conf Configure icon and the table configuration settings panel is displayed.
    • To move a table panel: Click the icon-drage Drag icon and move the table to new location in dashboard.
    • To remove a table panel: Click the icon-remove2 Remove icon.

The EVENTS BY TIME histogram panel

histogram

The default EVENT BY TIME histogram shows the number of the logs over an interval of time. The default interval period is set to 10 minutes.

  1. View panel: Provides options to change the histogram view. In the diagram, click icon-view, labeled with #1. The options from the view panel as shown by #2 and include the following options.
    • Bar: Data is displayed as a bar graph.
    • Lines: Data is displayed as a line graph.
    • Stack: Data for multiple queries is displayed as a stack.
    • Percent: Data for multiple queries is displayed as a percentage.
    • Legend: A legend is displayed over the View panel.
    • Interval: The interval of time value.
  2. Zoom In: Click a part of the graph to zoom in to that part of the data.
  3. Zoom Out: Click the icon-zoom-out icon to return to the full view of the graph.
  4. Histogram setting configuration: Provides setting configuration, Elasticsearch query inspection, duplication, moving, and removing histograms.
    • To view the Elasticsearch query for a histogram panel: Click the icon-inspect Inspect icon to see the last Elasticsearch query.
    • To duplicate a histogram panel: Click the icon-duplicate Duplicate icon to copy and paste the table.
    • To configure a histogram panel: Click the icon-conf Configure icon and the histogram configuration panel is displayed.
    • To move a histogram panel: Click the icon-drage Drag icon and move the histogram to a new location in the dashboard.
    • To remove a histogram panel: Click the icon-remove2 Remove icon.

The row and panel settings

row-panel-settings

  1. To collapse or expand a row: Click the icon-right-arrow icon to collapse or expand a row in the dashboard.
  2. To configure a row: Click the icon-config-row icon to open the General tab in the Row Settings panel and you can configure the row.
  3. To add a panel: Click the icon-add-panel icon to open the Add Panel tab in the Row Settings panel and you can select a panel type.
More stories
May 7, 2019

We’ve Moved! The IBM Cloud Blog Has a New URL

In an effort better integrate the IBM Cloud Blog with the IBM Cloud web experience, we have migrated the blog to a new URL: www.ibm.com/cloud/blog.

Continue reading

April 19, 2019

Reach Out to the IBM Cloud Development Teams on Slack

Get the help you need fast—directly from the IBM Cloud Development Teams and other users on Slack.

Continue reading

April 11, 2019

Permanent Redirect to cloud.ibm.com from console.bluemix.net

Starting on April 27, 2019, we will be turning on permanent redirects from bluemix.net to cloud.ibm.com. All of the same functionality that existed on bluemix.net is still available in cloud.ibm.com.

Continue reading