ttcn3_logformat(1)

📦 version 8.2.0, in debian bookworm, ubuntu jammy, ubuntu noble, ubuntu stonking

💖 ttcn3_logformat — the TTCN-3 log file formatter utility ✨

okay bestie, gather round, because this is the glow-up your ugly raw logs have been begging for 💅 This is the quick reference for the TTCN-3 logformat utility of the TTCN-3 Test Executor, and it lives in $TTCN3_DIR/bin (we'll get to that env var, don't worry 🫶).

🌸 SYNOPSIS 🌸

ttcn3_logformat [ -i n ] [ -o outfile ] [ -s ] [ file.log ] [ -n ]

or, when you just wanna know who she is:

ttcn3_logformat -v

✨ DESCRIPTION ✨

So ttcn3_logformat reads the unformatted log file that the test executor produces, and it reads it from standard input. That's the vibe. 🧚

What she does for you, bestie:

  • she can split the log into several files, based on the lines that get automatically logged at the beginning or end of each test case 📂
  • she formats the sent and received messages in the log file 📨
  • she indents structured values and puts each field on a new line, following the braces and commas 🎀

it's giving ✨ organized ✨ and honestly the difference is night and day, no cap.

👑 OPTIONS 👑

available command line switches, let's go:

  • -i n — sets the depth of each indentation level to n characters. the default is 4. if the sent or received PDU is too complex and has fields nested way too deep, you can decrease this number to get more readable output 🔥
  • -o outfile — puts the output into the file outfile. and if the -s flag is also set, only those parts of the log files get written into this file that were logged outside the test cases (i.e. in the control part or on PTCs). if you skip this option entirely, the formatted log just gets printed to standard output 💖
  • -s — if this is set, the entries recorded during the execution of a particular test case get saved in a separate file in the ttcn3_logformat working directory. the name of that file is identical to the name of the test case. if the same test case is executed several times one after another, the results of the repeated test runs get collected after each other. but heads up 👀 — if the output file already contained some data before ttcn3_logformat was started (like the results of a previous test run), the output file will be emptied and the old logs will be destroyed 💀

ttcn3_logformat recognizes any types of timestamps that can be set in the [LOGGING] section of the configuration file ⏰

WARNING! 🚨 this option is useless when formatting the log files of PTCs, because these logs do not contain the name of the testcase that the PTC belongs to. sorry bestie, that's just how it is 😭
  • -n — if this option is set, newline and tab characters are not modified — they're printed as \n and \t 🌈
  • -v — prints version and license key information and exits. short queen behavior, we respect it 💅

🌼 ENVIRONMENT VARIABLES 🌼

  • TTCN3_DIR — the installation directory where the uncompressed binary package of TTCN-3 Test Executor can be found. 🏠
  • TTCN3_LICENSE_FILE — it shall point to the file (NB: not to its directory, bestie, read it again 📢) that contains the personalized license key for the current user or host. 🔑

💀 BUGS 💀

None known at this time 🦋 (we love a flawless icon, periodt).

For trouble reporting use the tool MTTSMS.

For TR writers guide please visit the web page: http://ttcn.ericsson.se.

🫶 SEE ALSO 🫶

The User Documentation for the TTCN-3 Test Executor 📚

🎀 AUTHOR 🎀

This manpage is written by Csaba Koppany, Ericsson Telecom AB.

Copyright (c) 2000-2021 Ericsson Telecom AB. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v2.0 which accompanies this distribution, and is available at https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.html

and that's the whole page, bestie 💜 this one's from Ericsson Telecom AB, dated January 2021, living in the TTCN-3 Tools collection — go forth and make your logs pretty, iykyk 🌸✨

📦 where this page comes from