Skip to content

Commit 4645836

Browse files
committed
doc: Fix broken links and use https throughout in user guide
Signed-off-by: Bernd Hufmann <[email protected]>
1 parent 7f88866 commit 4645836

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

doc/org.eclipse.tracecompass.doc.user/doc/User-Guide.mediawiki

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ These views can be extended or tailored for specific trace types (e.g. kernel, H
5050
== LTTng integration ==
5151

5252
One of the main features of Trace Compass is the LTTng integration. LTTng (Linux Trace Toolkit, next generation) is a highly efficient tracing tool for Linux that can be used to track down kernel and application performance issues as well as troubleshoot problems involving multiple concurrent processes and threads. It consists of a set of kernel modules, daemons - to collect the raw tracing data - and a set of tools to control, visualize and analyze the generated data. It also provides support for user space application instrumentation.
53-
For more information about LTTng, refer to the project [http://lttng.org site]
53+
For more information about LTTng, refer to the project [https://lttng.org site]
5454

5555
'''Note''': This User Guide covers the integration of the latest LTTng (up to v2.4) in Eclipse.
5656

@@ -78,7 +78,7 @@ Also, the LTTng plug-ins supports the following User Space traces views:
7878
Finally, the LTTng plug-ins supports the following Control views:
7979
* ''Control'' - to control the tracer and configure the tracepoints
8080
81-
Although the control and fetching parts are targeted at the LTTng tracer, the underlying framework can also be used to process any trace that complies with the ''Common Trace Format'' ([http://www.efficios.com/ctf CTF]). CTF specifies a very efficient and compact binary trace format that is meant to be application-, architecture-, and language-agnostic.
81+
Although the control and fetching parts are targeted at the LTTng tracer, the underlying framework can also be used to process any trace that complies with the ''Common Trace Format'' ([https://diamon.org/ctf/v1.8.3/]). CTF specifies a very efficient and compact binary trace format that is meant to be application-, architecture-, and language-agnostic.
8282

8383
= Installation =
8484

@@ -94,7 +94,7 @@ The tracer and tools have been available for download in Ubuntu since 12.04. The
9494
> sudo apt-get install lttng-tools
9595
</pre>
9696

97-
For other distributions, older Ubuntu distributions, or the latest, bleeding edge LTTng tracer, please refer to the [http://lttng.org/download LTTng website] for installation information.
97+
For other distributions, older Ubuntu distributions, or the latest, bleeding edge LTTng tracer, please refer to the [https://lttng.org/download LTTng website] for installation information.
9898

9999
'''Note''': The LTTng tracer (and accompanying tools) is required only if you want to create your own traces (the usual case). If you intend to simply analyze existing traces then it is not necessary to install the tracer.
100100

@@ -141,7 +141,7 @@ On the host side (where Eclipse is running), you also need to have Eclipse Remot
141141

142142
== Installation Verification ==
143143

144-
If you do not have any traces, sample LTTng traces can be found here [http://lttng.org/files/samples]. This page contains links to some sample LTTng 2.0 kernel traces. The trace needs to be uncompressed to be opened. The traces can also be imported directly as archive, see the [[#Importing|Importing]] section for more detail.
144+
If you do not have any traces, sample LTTng traces can be found here [https://lttng.org/files/samples]. This page contains links to some sample LTTng 2.0 kernel traces. The trace needs to be uncompressed to be opened. The traces can also be imported directly as archive, see the [[#Importing|Importing]] section for more detail.
145145

146146
Here are the quick steps to verify that your installation is functional using a LTTng trace:
147147

@@ -685,7 +685,7 @@ Column order and size is preserved when changed. If a column is lost due to it b
685685
686686
Searching and filtering of events in the table can be performed by entering matching conditions in one or multiple columns in the header row (the first row below the column header).
687687
688-
To apply a matching condition to a specific column, click on the column's header row cell, type in a [http://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html regular expression]. You can also enter a simple text string and it will be automatically be replaced with a 'contains' regular expression.
688+
To apply a matching condition to a specific column, click on the column's header row cell, type in a [https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html regular expression]. You can also enter a simple text string and it will be automatically be replaced with a 'contains' regular expression.
689689
690690
Press the '''Enter''' key to apply the condition as a search condition. It will be added to any existing search conditions.
691691
@@ -947,7 +947,7 @@ An external analysis is a [[#Running an External Analysis|program executed by Tr
947947
948948
'''Note''': The program to execute is found by searching the directories listed in the standard <code>$PATH</code> environment variable when no path separator (<code>/</code> on Unix and OS X, <code>\</code> on Windows) is found in its command.
949949
950-
Trace Compass ships with a default list of ''descriptors'' of external analyses (not the analyses themselves), including the descriptors of the [http://github.com/lttng/lttng-analyses LTTng analyses]. If the LTTng analyses project is installed, its analyses are available when opening or importing an LTTng kernel trace.
950+
Trace Compass ships with a default list of ''descriptors'' of external analyses (not the analyses themselves), including the descriptors of the [https://github.com/lttng/lttng-analyses LTTng analyses]. If the LTTng analyses project is installed, its analyses are available when opening or importing an LTTng kernel trace.
951951
952952
=== Running an External Analysis ===
953953
@@ -991,9 +991,9 @@ To show or hide a result table once a [[#Creating a Chart from a Result Table|ch
991991
992992
=== Adding and Removing a User-Defined External Analysis ===
993993
994-
You can add a user-defined external analysis to the current list of external analyses. Note that the command to invoke must conform to the machine interface of [http://github.com/lttng/lttng-analyses LTTng analyses] 0.4.
994+
You can add a user-defined external analysis to the current list of external analyses. Note that the command to invoke must conform to the machine interface of [https://github.com/lttng/lttng-analyses LTTng analyses] 0.4.
995995
996-
'''Note''': If you want to create your own external analysis, consider following the [http://lttng.org/files/lami/lami-1.0.1.html LAMI 1.0 specification], which is supported by later versions of Trace Compass.
996+
'''Note''': If you want to create your own external analysis, consider following the [https://lttng.org/files/lami/lami-1.0.1.html LAMI 1.0 specification], which is supported by later versions of Trace Compass.
997997
998998
To add a user-defined external analysis:
999999
@@ -1025,12 +1025,12 @@ Fill out the first wizard page with the following information:
10251025
* '''Category''': Enter a category name for the trace type.
10261026
* '''Trace type''': Enter a name for the trace type, which is also the name of the custom parser. This will also be the default event type name.
10271027
* '''Time Stamp format''': Enter the date and time pattern that will be used to output the Time Stamp, or leave blank to use the default Time Format preference.<br>
1028-
Note: information about date and time patterns can be found here: [http://archive.eclipse.org/tracecompass/doc/stable/org.eclipse.tracecompass.doc.user/reference/api/org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html TmfTimestampFormat]
1028+
Note: information about date and time patterns can be found here: [https://archive.eclipse.org/tracecompass/doc/stable/org.eclipse.tracecompass.doc.user/reference/api/org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html TmfTimestampFormat]
10291029
10301030
Click the '''Add next line''', '''Add child line''' or '''Remove line''' buttons to create a new line of input or delete it. For each line of input, enter the following information:
10311031
10321032
* '''Regular expression''': Enter a regular expression that should match the input line in the log, using capturing groups to extract the data.<br>
1033-
Note: information about regular expression patterns can be found here: [http://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html]
1033+
Note: information about regular expression patterns can be found here: [https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html]
10341034
10351035
* '''Cardinality''': Enter the minimum and maximum number of lines matching this line's regular expression that must be found in the log. At least the minimum number of lines must be found before the parser will consider the next line. Child lines will always be considered first.
10361036
@@ -1096,7 +1096,7 @@ Fill out the first wizard page with the following information:
10961096
* '''Category''': Enter a category name for the trace type.
10971097
* '''Trace type''': Enter a name for the trace type, which is also the name of the custom parser. This will also be the default event type name.
10981098
* '''Time Stamp format''': Enter the date and time pattern that will be used to output the Time Stamp, or leave blank to use the default Time Format preference.<br>
1099-
Note: information about date and time patterns can be found here: [http://archive.eclipse.org/tracecompass/doc/stable/org.eclipse.tracecompass.doc.user/reference/api/org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html TmfTimestampFormat]
1099+
Note: information about date and time patterns can be found here: [https://archive.eclipse.org/tracecompass/doc/stable/org.eclipse.tracecompass.doc.user/reference/api/org/eclipse/tracecompass/tmf/core/timestamp/TmfTimestampFormat.html TmfTimestampFormat]
11001100
11011101
Click the '''Add document element''' button to create a new document element and enter a name for the root-level document element of the XML file.
11021102
@@ -2774,7 +2774,7 @@ Hover the cursor over a line of the chart and a tooltip will pop up with the fol
27742774
27752775
TraceCompass can recover wait causes of local and distributed processes using operating system events. The analysis highlights the tasks and devices causing wait. Wait cause recovery is recursive, comprise all tasks running on the system and works across computers using packet trace synchronization.
27762776
2777-
The analysis details are available in the paper [http://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=7294678&isnumber=4359390 Wait analysis of distributed systems using kernel tracing].
2777+
The analysis details are available in the paper [https://ieeexplore.ieee.org/stamp/stamp.jsp?tp=&arnumber=7294678&isnumber=4359390 Wait analysis of distributed systems using kernel tracing].
27782778
27792779
=== Prerequisites ===
27802780
@@ -2785,7 +2785,7 @@ The required events are:
27852785
* '''IRQ, SoftIRQ and IPI''': Interrupt events are required to distinguish the context of the wake-up. When a wake-up occurs inside an interrupt handler, it must be associated with the device causing the interrupt and not the interrupted task. For that reason, interrupt entry and exit events are required.
27862786
* '''inet_sock_local_in, inet_sock_local_out''': The network events record a subset of TCP/IP packet header using a netfilter hook in the kernel. The send and receive events are matched to show the communication between distributed processes. Network events are mandatory for analyzing wait in TCP/IP programs, whether they are executing locally or on different computers. They also used to synchronize traces recorded on multiple computers. For further details, refer to the [[#Trace synchronization]] section.
27872787
2788-
To analyze a distributed program, all computers involved in the processing must be traced simultaneously. The LTTng Tracer Control of TraceCompass can trace a remote computer, but controlling simultaneous tracing is not supported at the moment, meaning that all sessions must be started separately and interactively. TraceCompass will support this feature in the future. For now, it is suggested to use [https://github.com/giraldeau/lttng-cluster lttng-cluster] command line tool to control simultaneous tracing sessions on multiple computers. This tool is based on [http://www.fabfile.org/ Fabric] and uses SSH to start the tracing sessions, execute a workload, stop the sessions and gather traces on the local computer. For more information, refer to the lttng-cluster documentation.
2788+
To analyze a distributed program, all computers involved in the processing must be traced simultaneously. The LTTng Tracer Control of TraceCompass can trace a remote computer, but controlling simultaneous tracing is not supported at the moment, meaning that all sessions must be started separately and interactively. TraceCompass will support this feature in the future. For now, it is suggested to use [https://github.com/giraldeau/lttng-cluster lttng-cluster] command line tool to control simultaneous tracing sessions on multiple computers. This tool is based on [https://www.fabfile.org/ Fabric] and uses SSH to start the tracing sessions, execute a workload, stop the sessions and gather traces on the local computer. For more information, refer to the lttng-cluster documentation.
27892789
27902790
We use the [https://github.com/giraldeau/traces/blob/master/django-vote.tar.gz Django trace] as an example to demonstrate the wait analysis. [https://www.djangoproject.com/ Django] is a popular Web framework. The application is the [https://docs.djangoproject.com/en/1.9/intro/tutorial01/ Django Poll app tutorial]. The traces were recorded on three computers, namely the client (implemented with Python Mechanize), the Web server (Apache with WSGI) and the database server (PostgreSQL). The client simulates a vote in the poll.
27912791
@@ -2980,7 +2980,7 @@ the relevant information.
29802980
Note that for non-trivial applications, ''liblttng-ust-cyg-profile'' generates a
29812981
'''lot''' of events! You may need to increase the channel's subbuffer size to
29822982
avoid lost events. Refer to the
2983-
[http://lttng.org/docs/#doc-fine-tuning-channels LTTng documentation].
2983+
[https://lttng.org/docs/#doc-fine-tuning-channels LTTng documentation].
29842984
29852985
For traces taken with LTTng-UST 2.8 or later, the Flame Chart View should show the
29862986
function names automatically, since it will make use of the debug information
@@ -3519,7 +3519,7 @@ The state system obtained by the state provider can then be used to populate dat
35193519
35203520
=== Definitions and example ===
35213521
3522-
Before we start, we'll define a few terms used in the following sections. The interested reader should read the [https://wiki.eclipse.org/index.php/Trace_Compass#User_Guides Tmf Developer Guide] for more complete description of the state system and state providers.
3522+
Before we start, we'll define a few terms used in the following sections. The interested reader should read the [https://github.com/eclipse-tracecompass/org.eclipse.tracecompass/wiki#user-guides Tmf Developer Guide] for more complete description of the state system and state providers.
35233523
35243524
* The '''state system''' can be viewed as a model of the system, where the different elements (attributes) can be seen as a tree, and their evolution (states) is tracked through time.
35253525
@@ -4197,7 +4197,7 @@ The Counters View supports experiments.
41974197
41984198
== Creating an LTTng trace with performance counters ==
41994199
4200-
For the Counters View to display any data, the trace needs to collect information related to performance counters. There are two ways to configure a trace for this type of logging. On the command line, add a new context field to an LTTng channel using the <code>lttng-add-context</code> command (for more information, refer to the [http://lttng.org/docs/ LTTng documentation]). On the LTTng Tracer Control, add a new context field using the ''Add Context..." window (see [[#Adding Contexts to Channels and Events of a Domain]]).
4200+
For the Counters View to display any data, the trace needs to collect information related to performance counters. There are two ways to configure a trace for this type of logging. On the command line, add a new context field to an LTTng channel using the <code>lttng-add-context</code> command (for more information, refer to the [https://lttng.org/docs/ LTTng documentation]). On the LTTng Tracer Control, add a new context field using the ''Add Context..." window (see [[#Adding Contexts to Channels and Events of a Domain]]).
42014201

42024202
== Counters View ==
42034203

@@ -4297,7 +4297,7 @@ Here is an example ''logger.properties'' file to control what is being logged an
42974297
42984298
== LTTng JUL log handler ==
42994299

4300-
The various log handlers have an overhead on the application. The ConsoleHandler has a visible impact on Trace Compass performance. The FileHandler also has an overhead though less visible, but when logging from multiple threads at the same time, the file becomes a bottleneck, so that logging data cannot be used with accuracy for performance analysis. The [http://lttng.org/docs/#doc-java-application LTTng log handler] is much better in a multi-threads context.
4300+
The various log handlers have an overhead on the application. The ConsoleHandler has a visible impact on Trace Compass performance. The FileHandler also has an overhead though less visible, but when logging from multiple threads at the same time, the file becomes a bottleneck, so that logging data cannot be used with accuracy for performance analysis. The [https://lttng.org/docs/#doc-java-application LTTng log handler] is much better in a multi-threads context.
43014301

43024302
LTTng-UST comes with the Java JUL agent in most distros. Otherwise, it is possible to manually compile lttng-ust with options ''--enable-java-agent-jul'' and install it.
43034303

@@ -4383,12 +4383,12 @@ Alice kills the program, and immediately the server speeds up. She then goes to
43834383

43844384
To install features from the Trace Compass incubator, use the following update site URL: https://download.eclipse.org/tracecompass.incubator/master/repository/.
43854385

4386-
If you're using the Trace Compass RCP, there's an easy method to install incubator features. See the [http://archive.eclipse.org/tracecompass/doc/stable/org.eclipse.tracecompass.rcp.doc.user/Trace-Compass-Incubator.html Trace Compass RCP documentation]
4386+
If you're using the Trace Compass RCP, there's an easy method to install incubator features. See the [https://archive.eclipse.org/tracecompass/doc/stable/org.eclipse.tracecompass.rcp.doc.user/Trace-Compass-Incubator.html Trace Compass RCP documentation]
43874387

43884388
= References =
43894389

4390-
* [http://www.eclipse.org/tracecompass Trace Compass project]
4391-
* [https://wiki.eclipse.org/index.php/Trace_Compass#User_Guides Trace Compass User Guides]
4392-
* [http://www.lttng.org/ LTTng project]
4393-
* [http://lttng.org/files/doc/man-pages/man1/lttng.1.html LTTng Tracer Control Command Line Tool User Manual]
4394-
* [http://lttng.org/files/doc/man-pages/man8/lttng-relayd.8.html LTTng relayd User Manual]
4390+
* [https://projects.eclipse.org/projects/tools.tracecompass Trace Compass project]
4391+
* [https://github.com/eclipse-tracecompass/org.eclipse.tracecompass/wiki#user-guides Trace Compass User Guides]
4392+
* [https://www.lttng.org/ LTTng project]
4393+
* [https://lttng.org/files/doc/man-pages/man1/lttng.1.html LTTng Tracer Control Command Line Tool User Manual]
4394+
* [https://lttng.org/files/doc/man-pages/man8/lttng-relayd.8.html LTTng relayd User Manual]

0 commit comments

Comments
 (0)