2 * Copyright (C) 2015, EfficiOS Inc., Alexandre Montplaisir <alexmonthy@efficios.com>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 package org
.lttng
.tools
;
21 import java
.util
.List
;
25 * Java representation of a LTTng tracing session.
27 * @author Alexandre Montplaisir
29 public interface ILttngSession
extends AutoCloseable
{
32 * Tracing domains as they are defined by lttng-tools
35 /** The JUL (java.util.logging) domain */
36 JUL("-j"), /** The log4j (org.apache.log4j) domain */
39 private final String flag
;
41 private Domain(String flag
) {
46 * @return The corresponding command-line flag to pass to options like
47 * "lttng enable-event"
49 public String
flag() {
54 // ------------------------------------------------------------------------
56 // ------------------------------------------------------------------------
59 * Create a new LTTng tracing session using the default backend.
62 * The name of the session to use. It can be null, in which case
63 * we will provide a unique random name.
65 * The tracing domain of this session
66 * @return The new session object
68 static ILttngSession
createSession(String sessionName
, Domain domain
) {
69 return createCommandLineSession(sessionName
, domain
);
73 * Create a new LTTng tracing session, which will use the command-line
77 * The name of the session to use. It can be null, in which case
78 * we will provide a unique random name.
80 * The tracing domain of this session
81 * @return The new session object
83 static ILttngSession
createCommandLineSession(String sessionName
, Domain domain
) {
84 return new LttngCommandLineSession(sessionName
, domain
);
87 // ------------------------------------------------------------------------
89 // ------------------------------------------------------------------------
92 * Should be used to destroy the LTTng session.
97 // ------------------------------------------------------------------------
99 // ------------------------------------------------------------------------
102 * Enable an individual event, specifying a loglevel and filter string.
105 * The name of the event to enable
107 * The loglevel, will be passed as-is to lttng. May be null to
109 * @param loglevelOnly
110 * True to use this log level only (--loglevel-only), or false to
111 * include all more severe levels (--loglevel). Ignored if
112 * "loglevel" is null.
114 * The filter string, may be null to not specify one.
115 * @return If the command executed successfully (return code = 0)
117 boolean enableEvent(String eventName
, String loglevel
, boolean loglevelOnly
, String filter
);
120 * Enable individual event(s) with no loglevel/filter specified.
122 * @param enabledEvents
123 * The list of events to enable. Should not be null or empty
124 * @return If the command executed successfully (return code = 0).
126 boolean enableEvents(String
... enabledEvents
);
129 * Enable all events in the session (as with "enable-event -a").
131 * @return If the command executed successfully (return code = 0).
133 boolean enableAllEvents();
136 * Send a disable-event command. Used to disable event(s) that were previously
139 * @param disabledEvents
140 * The list of disabled events. Should not be null or empty
141 * @return If the command executed successfully (return code = 0).
143 boolean disableEvents(String
... disabledEvents
);
146 * Disable all events currently enabled in the session
147 * ("lttng disable-event -a").
149 * @return If the command executed successfully (return code = 0)
151 boolean disableAllEvents();
154 * Get a list of events currently available (exposed by applications) in the
157 * @return The list of available events
159 Set
<String
> listEvents();
164 * @return If the command executed successfully (return code = 0).
169 * Stop the tracing session
171 * @return If the command executed successfully (return code = 0).
176 * Issue a "lttng view" command on the session, and returns its output. This
177 * effectively returns the current content of the trace in text form.
179 * @return The output of Babeltrace on the session's current trace
This page took 0.043751 seconds and 5 git commands to generate.