Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

Navigation
Guide That Contains This Content
[+] Expand All
[-] Collapse All

    Query > Logs

    The Query > Logs option allows you to access the system log and object log activity of any Contrail Controller component from one central location.

    Query > Logs Menu Options

    Click Query > Logs to access the Query Logs menu, where you can select System Logs to view system log activity, Object Logs to view object logs activity, and Query Queue to create custom queries of log activity; see Figure 1.

    Figure 1: Query > Logs

    Query > Logs

    Query > Logs > System Logs

    Click Query > Logs > System Logs to access the Query System Logs menu, where you can view system logs according to criteria that you determine. See Figure 2.

    Figure 2: Query > Logs > System Logs

    Query > Logs > System Logs

    The query fields available on the Query System Logs screen are described in Table 1.

    Table 1: Query System Logs Fields

    Field

    Description

    Time Range

    Select a range of time for which to see the system logs:

    • Last 10 Mins
    • Last 30 Mins
    • Last 1 Hr
    • Last 6 Hrs
    • Last 12 Hrs
    • Custom

    If you click Custom, enter a desired time range in two new fields: From Time and To Time.

    Where

    Click the edit button (pencil icon) to open a query-writing window, where you can specify query values for variables such as Source, Module, MessageType, and the like, in order to retrieve specific information.

    Level

    Select the message severity level to view:

    • SYS_NOTICE
    • SYS_EMERG
    • SYS_ALERT
    • SYS_CRIT
    • SYS_ERR
    • SYS_WARN
    • SYS_INFO
    • SYS_DEBUG

    Run Query

    Click this button to retrieve the system logs that match the query. The logs are listed in a box with columns showing the Time, Source, Module Id, Category, Log Type, and Log message.

    Export

    This button appears after you click Run Query, allowing you to export the list of system messages to a text/csv file.

    Sample Query for System Logs

    This section shows a sample system logs query designed to show all System Logs from ModuleId = VRouterAgent on Source = b1s16 and filtered by Level = SYS_DEBUG.

    1. At the Query System Logs screen, click in the Where field to access the Where query screen and enter information defining the location to query in the Edit Where Clause section and click OK; see Figure 3.

      Figure 3: Edit Where Clause

      Edit Where Clause
    2. The information you defined at the Where screen displays on the Query System Logs. Enter any more defining information needed; see Figure 4. When finished, click Run Query to display the results.

      Figure 4: Sample Query System Logs

      Sample Query System Logs

    Query > Logs > Object Logs

    Object logs allow you to search for logs associated with a particular object, for example, all logs for a specified virtual network. Object logs record information related to modifications made to objects, including creation, deletion, and other modifications; see Figure 5.

    Figure 5: Query > Logs > Object Logs

    Query > Logs > Object Logs

    The query fields available on the Object Logs screen are described in Table 2.

    Table 2: Object Logs Query Fields

    Field

    Description

    Time Range

    Select a range of time for which to see the logs:

    • Last 10 Mins
    • Last 30 Mins
    • Last 1 Hr
    • Last 6 Hrs
    • Last 12 Hrs
    • Custom

    If you click Custom, enter a desired time range in two new fields: From Time and To Time.

    Object Type

    Select the object type for which to show logs:

    • Virtual Network
    • Virtual Machine
    • Virtual Router
    • BGP Peer
    • Routing Instance
    • XMPP Connection

    Object Id

    Select from a list of available identifiers the name of the object you wish to use.

    Select

    Click the edit button (pencil icon) to open a window where you can select searchable types by clicking a checkbox:

    • ObjectLog
    • SystemLog

    Where

    Click the edit button (pencil icon) to open the query-writing window, where you can specify query values for variables such as Source, ModuleId, and MessageType, in order to retrieve information as specific as you wish.

    Run Query

    Click this button to retrieve the system logs that match the query. The logs are listed in a box with columns showing the Time, Source, Module Id, Category, Log Type, and Log message.

    Export

    This button appears after you click Run Query, allowing you to export the list of system messages to a text/csv file.

    Modified: 2015-09-02