RetroSearch Browse

(

new 300 cmd

->SetUsageContext(

GetArguments

().GetProgramBasename(),

"Command-line utility to log to AppLog"

);

305

arg->SetUsageContext(

"Start application. Return token."

false

, kUsageWidth);

306

arg->SetDetailedDescription(

307 "Starting logging. You should specify a name of application for that you log and its PID at least. " 308 "First, utility tries to log locally (to /log) by default. If it can't do that then it try to call " 309 "a CGI that does the logging on other machine, or log to stderr on error." 310 "Returns logging token that should be used for any subsequent app related calls." 323

(

"timestamp"

"TIME"

"Posting time if differ from current (YYYY-MM-DDThh:mm:ss, MM/DD/YY hh:mm:ss, time_t)."

326

(

"mode"

"MODE"

"Use local/redirect logging ('redirect' will be used automatically if /log is not accessible on current machine)"

331

(

"logsite"

"SITE"

"Value for logsite parameter. If empty $NCBI_APPLOG_SITE will be used."

336

(

"hostrole"

"ROLE"

"Host role (will be used automatically for 'redirect' mode)"

339

(

"hostloc"

"LOCATION"

"Host location (will be used automatically for 'redirect' mode)"

342

(

"srvport"

"PORT"

"Server port (will be used automatically for 'redirect' mode)"

344 cmd

->AddCommand(

"start_app"

, arg.release());

350

arg->SetUsageContext(

"Stop application."

false

, kUsageWidth);

351

arg->SetDetailedDescription(

352 "Stop logging and invalidate passed token. This command should be last in the logging session." 355

(

"token"

"Session token, obtained from stdout for <start_app> or <start_request> command."

);

359

(

"timestamp"

"TIME"

"Posting time if differ from current (YYYY-MM-DDThh:mm:ss, MM/DD/YY hh:mm:ss, time_t)."

362

(

"exectime"

"TIMESPAN"

"Application execution time. If not specified, calculates on base " 363 "of -timestamp parameters for start/stop commands, or current time."

368

(

"mode"

"MODE"

"Use local/redirect logging ('redirect' will be used automatically if /log is not accessible on current machine)"

372 cmd

->AddCommand(

"stop_app"

, arg.release());

378

arg->SetUsageContext(

"Start request. Return token."

false

, kUsageWidth);

379

arg->SetDetailedDescription(

380 "Starting logging request. " 381 "Returns logging token specific for this request, it should be used for all subsequent calls related " 382 "to this request. The <stop_request> command invalidate it." 385

(

"token"

"Session token, obtained from stdout for <start_app> command or previous request."

);

397

(

"timestamp"

"TIME"

"Posting time if differ from current (YYYY-MM-DDThh:mm:ss, MM/DD/YY hh:mm:ss, time_t)."

401

(

"mode"

"MODE"

"Use local/redirect logging ('redirect' will be used automatically if /log is not accessible on current machine)"

405 cmd

->AddCommand(

"start_request"

, arg.release());

411

arg->SetUsageContext(

"Stop request."

false

, kUsageWidth);

412

arg->SetDetailedDescription(

413 "Stop logging request. " 414 "Invalidate request specific token obtained for <start_request> command. " 415 "Returns the same token as <start_app> command, so you can use any for logging between requests." 426

(

"timestamp"

"TIME"

"Posting time if differ from current (YYYY-MM-DDThh:mm:ss, MM/DD/YY hh:mm:ss, time_t)."

431

(

"mode"

"MODE"

"Use local/redirect logging ('redirect' will be used automatically if /log is not accessible on current machine)"

435 cmd

->AddCommand(

"stop_request"

, arg.release());

441

arg->SetUsageContext(

"Post a message."

false

, kUsageWidth);

442

arg->SetDetailedDescription(

443 "Post a message to the log with specified severity." 446

(

"token"

"Session token, obtained from stdout for <start_app> or <start_request> command."

);

453

(

"severity"

, &(*

new CArgAllow_Strings

"trace"

"info"

"warning"

"error"

"critical"

));

456

arg->AddFlag(

"note"

"Post message as a note, using Note[X] notation for a severity"

);

458

(

"timestamp"

"TIME"

"Posting time if differ from current (YYYY-MM-DDThh:mm:ss, MM/DD/YY hh:mm:ss, time_t)."

463

(

"mode"

"MODE"

"Use local/redirect logging ('redirect' will be used automatically if /log is not accessible on current machine)"

467 cmd

->AddCommand(

"post"

, arg.release());

473

arg->SetUsageContext(

"Post an extra information."

false

, kUsageWidth);

476

(

"token"

"Session token, obtained from stdout for <start_app> or <start_request> command."

);

480

(

"timestamp"

"TIME"

"Posting time if differ from current (YYYY-MM-DDThh:mm:ss, MM/DD/YY hh:mm:ss, time_t)."

485

(

"mode"

"MODE"

"Use local/redirect logging ('redirect' will be used automatically if /log is not accessible on current machine)"

489 cmd

->AddCommand(

"extra"

, arg.release());

495

arg->SetUsageContext(

"Post performance information."

false

, kUsageWidth);

498

(

"token"

"Session token, obtained from stdout for <start_app> or <start_request> command."

);

506

(

"timestamp"

"TIME"

"Posting time if differ from current (YYYY-MM-DDThh:mm:ss, MM/DD/YY hh:mm:ss, time_t)."

511

(

"mode"

"MODE"

"Use local/redirect logging ('redirect' will be used automatically if /log is not accessible on current machine)"

515 cmd

->AddCommand(

"perf"

, arg.release());

522

arg->SetUsageContext(

"Parse token information and print requested field to stdout."

false

, kUsageWidth);

525

(

"token"

"Session token, obtained from stdout for <start_app> or <start_request> command."

);

526

arg->AddFlag(

"appname"

"Name of the application."

);

527

arg->AddFlag(

"client"

"Client IP address."

);

528

arg->AddFlag(

"guid"

"Globally unique process ID."

);

529

arg->AddFlag(

"host"

"Name of the host where the application runs."

);

530

arg->AddFlag(

"hostrole"

"Host role."

);

531

arg->AddFlag(

"hostloc"

"Host location."

);

532

arg->AddFlag(

"logsite"

"Value for logsite parameter."

);

533

arg->AddFlag(

"pid"

"Process ID of the application."

);

534

arg->AddFlag(

"sid"

"Session ID (application-wide or request, depending on the type of token)."

);

535

arg->AddFlag(

"phid"

"Hit ID (application-wide value)."

);

536

arg->AddFlag(

"rid"

"Request ID."

);

537

arg->AddFlag(

"srvport"

"Server port."

);

538

arg->AddFlag(

"app_start_time"

"Application start time (time_t value)."

);

539

arg->AddFlag(

"req_start_time"

"Request start time (for request-type tokens only, time_t value)."

);

540 cmd

->AddCommand(

"parse_token"

, arg.release());

546

arg->SetUsageContext(

"Generate an Applog query URL."

false

, kUsageWidth);

547

arg->SetDetailedDescription(

548 "Generate an Applog query URL on a base of token information and print it to stdout. " 549 "Token can be obtained from <start_app> or <start_request> command. " 550 "Generated URL will include data to a whole application or request only, accordingly to " 551 "the type of specified token and provided flags. Also, this command should be called " 552 "after <stop_app> or <stop_request> to get correct date/time range for the query. " 553 "Or you can use -maxtime argument to specify the end of the query time range. " 554 "Starting date/time for a query will be automatically obtained from the token. " 555 "The generated url query includes only a minimum information by default, " 556 "at least one flag should be used to add search terms, if in doubt use -std flag." 557 "This operation doesn't affect current logging (if any)." 560

(

"token"

"Session token, obtained from stdout for <start_app> or <start_request> command."

);

561

arg->AddFlag(

"std"

"Include application name, host name and pid to the query. " 562 "Automatically imply -appname, -host and -pid flags."

);

563

arg->AddFlag(

"appname"

"Include application name to the query."

);

564

arg->AddFlag(

"host"

"Include host name to the query."

);

565

arg->AddFlag(

"pid"

"Include process ID of the application to the query."

);

566

arg->AddFlag(

"sid"

"Include session ID (application-wide or request, depending on the type of token) to the query."

);

567

arg->AddFlag(

"phid"

"Include hit ID (application-wide or request, depending on the type of token) to the query."

);

568

arg->AddDefaultKey(

"maxtime"

"TIME"

569 "Specify ending date/time for a query range, current by default (YYYY-MM-DDThh:mm:ss, MM/DD/YY hh:mm:ss, time_t)."

571

arg->AddDefaultKey(

"maxtime-delay"

"TIMESPAN"

572 "A timespan used to adjust ending date/time for a query, specified by -maxtime argument " 573 "(or current time, if not specified). Could be useful to get an URL before sending <stop_app> " 574 "command and to avoid any time calculations directly in the scripts. " 575 "Accept a string with timespan in the human readable format (like '100 seconds', '100s', '2m 30s', '1d')."

577 cmd

->AddCommand(

"url"

, arg.release());

583

arg->SetUsageContext(

"Post already prepared log in applog format."

false

, kUsageWidth);

584

arg->SetDetailedDescription(

585 "Copy already existing data in applog format to the log. You can specify a file name with data " 586 "or print it to the standard input. All lines in non-applog format will be ignored. " 587 "If $NCBI_APPLOG_SITE environment variable is specified, that the application name in the passed " 588 "logging data will be replaced with its value and original application name added as 'extra'." 591

(

"file"

"filename"

"Name of the file with log lines. Use '-' to read from the standard input."

594

(

"appname"

"NAME"

"Name of the application (optional). If empty, an application name from " 595 "the first RAW line will be used. This parameter affects the name of the created log file only."

598

(

"logsite"

"SITE"

"Value for logsite parameter. If empty $NCBI_APPLOG_SITE will be used."

604

(

"nl"

"N"

"Turn ON incremental logging for CGI redirects. " 605 "Send previously accumulated data after every specified number of log lines."

608

(

"nr"

"N"

"Turn ON incremental logging for CGI redirects. " 609 "Send previously accumulated data after every specified number of requests."

612

(

"timeout"

"SEC"

"Turn ON incremental logging for CGI redirects ('-' source only). " 613 "Send previously accumulated data after specified number of seconds of inactivity in the standard input."

624

(

"mode"

"MODE"

"Use local/redirect logging ('redirect' will be used automatically if /log is not accessible on current machine)"

626 cmd

->AddCommand(

"raw"

, arg.release());

632

arg->SetUsageContext(

"Generate and return IDs."

false

, kUsageWidth);

633

arg->SetDetailedDescription(

634 "This operation doesn't affect current logging (if any). All flags will be " 635 "processed and printed in the exact order they were specified in the command line. " 636 "If more than one flag specified, each value will be printed on a separate line." 640 "Generate and return Hit ID (PHID) to use in the user script."

);

643 "Generate and return Session ID (SID) to use in the user script."

);

645

(

"format"

"FORMAT"

"Output format for generated values."

649 cmd

->AddCommand(

"generate"

, arg.release());

655

arg->SetUsageContext(

"Health checks."

false

, kUsageWidth);

656

arg->SetDetailedDescription(

657 "Check local and CGI logging capabilities, print short report to stdout " 658 "in the NCBI registry format. Exit with status code 0 if logging is possible " 659 "(local or via CGI). If this is allowed via CGI only, check that versions " 660 "for local and CGI executables match." 663

(

"logsite"

"SITE"

"Value for logsite parameter. If empty $NCBI_APPLOG_SITE will be used."

668

(

"mode"

"MODE"

"Use local/redirect logging ('redirect' will be used automatically if /log is not accessible on current machine)"

672 cmd

->AddCommand(

"health"

, arg.release());

687 #if defined(NCBI_OS_MSWIN) 692 unsigned long

timeout_msec = timeout.

IsInfinite

() ? 1

694 HANDLE

hStdin = GetStdHandle(STD_INPUT_HANDLE);

700 unsigned long

x_sleep = 1;

701 DWORD

bytes_avail = 0;

705 if

( !res || !timeout_msec) {

715 if

(x_sleep > timeout_msec) {

716

x_sleep = timeout_msec;

718

timeout_msec -= x_sleep;

732

poll_fd[0].

= fileno(stdin);

736 int n

poll

(poll_fd, 1, timeout_msec);

746 if

(errno != EINTR) {

771 bool

need_hostname =

true

;

772 bool

need_sid =

true

;

773 bool

need_phid =

true

;

774 bool

need_logsite =

true

;

775 bool

skip_next_arg =

false

;

779 for

(

size_t i

= 1;

< raw_args.

(); ++

) {

781

skip_next_arg =

false

;

784 if

(

== 2 && !is_start_app && raw_args[

empty

() ) {

787

s_args +=

" \""

m_Token

"\""

;

792

need_hostname =

false

;

801

need_logsite =

false

;

817

skip_next_arg =

true

;

820

s_args +=

" \""

+ raw_args[

] +

"\""

;

841 if

(!logsite.empty()) {

880

cgi << s_args << endl;

896

*cgi << header << endl;

907

ECgiSplitMethod method = eRAW_AllAtOnce;

909 size_t

criterion_count = 1;

913

method = eRAW_NumLines;

914

criterion_count = args[

"nl"

].AsInteger();

917

method = eRAW_NumRequests;

918

criterion_count = args[

"nr"

].AsInteger();

920 if

(args[

"timeout"

]) {

924

method = eRAW_Timeout;

925

criterion_timeout.

Set

(args[

"timeout"

].AsDouble());

930 size_t

n_sent_lines = 0;

931 size_t

n_sent_requests = 0;

944 bool

need_split =

false

;

948

need_split = (n_sent_lines % criterion_count == 0);

950 case

eRAW_NumRequests:

953 size_t

namepos, namelen;

958

need_split = (n_sent_requests % criterion_count == 0);

980 if

(method == eRAW_Timeout) {

985

*cgi << header << endl;

998 throw

std::runtime_error(

"Failed to redirect request to CGI"

);

1002

getline(cgi,

output

'\0'

);

1004 throw

std::runtime_error(

"Failed to read CGI output"

);

1007 if

(res != 0 && res != 200) {

1008 throw

std::runtime_error(

"Failed to call CGI, HTTP status code "

NStr::IntToString

(res));

1015 throw

std::runtime_error(

"Failed to call CGI: "

output

);

1027 if

(!apos || !apos[0] || !apos[1] || (apos[0] >= apos[1])) {

1028 throw

std::runtime_error(

"Error processing input raw log, line has wrong format"

);

1031

*from = (size_t)apos[0];

1034

len

= (size_t)(apos[1] - apos[0]);

1037

*appname =

m_Raw_line

.substr(apos[0], apos[1] - apos[0]);

1105 bool

have_name =

false

1109

have_atime =

false

1110

have_rtime =

false

;

1112 ITERATE

(list<string>, pair, pairs) {

1116 if

(

"name"

) {

1119

}

else if

(

"pid"

) {

1122

}

else if

(

"guid"

) {

1125

}

else if

(

"host"

) {

1127

}

else if

(

"hostrole"

) {

1129

}

else if

(

"hostloc"

) {

1131

}

else if

(

"srvport"

) {

1133

}

else if

(

"client"

) {

1135

}

else if

(

"asid"

) {

1137

}

else if

(

"rsid"

) {

1140

}

else if

(

"phid"

) {

1142

}

else if

(

"logsite"

) {

1144

}

else if

(

"rid"

) {

1148

}

else if

(

"atime"

) {

1154

}

else if

(

"rtime"

) {

1163 if

(!(have_name && have_pid && have_guid && have_atime)) {

1164 throw

std::runtime_error(

"Token string has wrong format"

);

1167 if

(!(have_rid && have_rtime)) {

1168 throw

std::runtime_error(

"Token string has wrong format (request token type expected)"

);

1179 bool

need_eol = (raw_args.

() > 4);

1181 for

(

size_t i

= 3;

< raw_args.

(); ++

) {

1182 string

arg = raw_args[

];

1183 if

(arg ==

"-appname"

) {

1185

}

else if

(arg ==

"-client"

) {

1187

}

else if

(arg ==

"-guid"

) {

1189

}

else if

(arg ==

"-host"

) {

1191

}

else if

(arg ==

"-hostrole"

) {

1193

}

else if

(arg ==

"-hostloc"

) {

1195

}

else if

(arg ==

"-logsite"

) {

1197

}

else if

(arg ==

"-pid"

) {

1199

}

else if

(arg ==

"-sid"

) {

1201

}

else if

(arg ==

"-phid"

) {

1203

}

else if

(arg ==

"-rid"

) {

1205

}

else if

(arg ==

"-srvport"

) {

1207

}

else if

(arg ==

"-app_start_time"

) {

1209

}

else if

(arg ==

"-req_start_time"

) {

1212 Error

(

"Unknown command line argument: "

+ arg);

1282 throw

std::runtime_error(

"PHID is too long '"

m_Info

phid_app

"'"

);

1346 static const char

* kPHID =

"NCBI_LOG_HIT_ID"

;

1347 static const char

* kSID =

"NCBI_LOG_SESSION_ID"

;

1350 const string

fmt =

GetArgs

()[

"format"

].AsString();

1354 bool

newline =

false

;

1358 for

(

size_t i

= 1;

< raw_args.

(); ++

) {

1359 string

arg = raw_args[

];

1360 const char

env

nullptr

;

1362 if

(arg ==

"-phid"

) {

1367

}

else if

(arg ==

"-sid"

) {

1377 if

(fmt ==

"shell"

|| fmt ==

"shell-export"

) {

1378

cout <<

env

"="

;

1381 if

(fmt ==

"shell-export"

) {

1382

cout <<

"\nexport "

env

'\n'

;

1397 static const char

* kCgi =

"CGI"

;

1398 static const char

* kLocal =

"LOCAL"

;

1399 static const char

kVersion

"Version"

;

1400 static const char

* kLog =

"Log"

;

1403 if

(args[

"mode"

].AsString() ==

"cgi"

) {

1435 string

s_args =

"health "

;

1443

cgi << s_args << endl;

1447 bool

is_cgi_on =

false

;

1448 int

http_status = -1;

1452

getline(cgi,

output

'\0'

);

1454

is_cgi_on = (http_status == 0 || http_status == 200) &&

1468 return

is_log_writable ? 0 : 1;

1476 catch

(exception&) {}

1482 if

(!is_log_writable) {

1496 bool

is_api_init =

false

;

1508 if

(args.

Exist

(

"logsite"

)) {

1516 if

(

"start_app"

) {

1520 string

srvport = args[

"srvport"

].AsString();

1521 if

( srvport.empty() ) {

1528 if

(

"raw"

) {

1531 string

filename = args[

"file"

].AsString();

1532 if

(filename ==

"-"

) {

1537 throw

std::runtime_error(

"Failed to open file '"

+ filename +

"'"

);

1549 bool

found =

false

;

1557 throw

std::runtime_error(

"Error processing input raw log, cannot find any line in applog format"

);

1564 if

(

"generate"

) {

1568 if

(

"health"

) {

1573 m_Token

= args[

"token"

].AsString();

1578 throw

std::runtime_error(

"Syntax error: Please specify token argument in the command line or via $NCBI_APPLOG_TOKEN"

);

1581 if

(

"parse_token"

) {

1591 if

(args.

Exist

(

"timestamp"

)) {

1592

timestamp = args[

"timestamp"

].AsString();

1594 if

(timestamp.empty() &&

"url"

) {

1596

timestamp = args[

"maxtime"

].AsString();

1598 if

( !timestamp.empty() ) {

1600 if

(timestamp.length() == 19 && timestamp.find(

"T"

) !=

NPOS

) {

1604 else if

(timestamp.length() == 17 && timestamp.find(

"/"

) !=

NPOS

) {

1614 if

(

"url"

) {

1618 if

(args[

"std"

]) {

1625 if

(args[

"appname"

]) {

1629 if

(args[

"host"

]) {

1632 if

(args[

"pid"

]) {

1636 if

(args[

"sid"

]) {

1639 if

(args[

"phid"

]) {

1656 string

timespan = args[

"maxtime-delay"

].AsString();

1657 if

(!timespan.empty()) {

1670 string mode

= args[

"mode"

].AsString();

1671 if

(

mode

"redirect"

) {

1674 if

(

mode

"cgi"

) {

1697

is_api_init =

true

;

1700

-- GUID approach

for

logfile

names 1710 if

(!logfile.empty()) {

1720 throw

std::runtime_error(

"Failed to set output destination from $NCBI_CONFIG__LOG__FILE"

);

1726 if

(dst_str.empty() || dst_str ==

"default"

) {

1732

is_api_init =

false

;

1736 throw

std::runtime_error(

"/log is not writable for CGI logger"

);

1741 if

(dst_str ==

"file"

) {

1748 throw

std::runtime_error(

"Failed to set output destination to file '"

+ path +

"'"

);

1752 if

(dst_str ==

"stdlog"

) {

1755 if

(dst_str ==

"cwd"

) {

1758 if

(dst_str ==

"stdout"

) {

1761 if

(dst_str ==

"stderr"

) {

1764 throw

std::runtime_error(

"Syntax error: NcbiApplogDestination parameter have incorrect value "

+ dst_str);

1769 if

(cur_dst != dst) {

1770 throw

std::runtime_error(

"Failed to set output destination to "

+ dst_str);

1783 if

(

"start_app"

) {

1785 m_Info

pid

= args[

"pid"

].AsInteger();

1821 if

(

"stop_app"

) {

1822 int

status = args[

"status"

].AsInteger();

1823 double

exectime = 0;

1824 if

(args[

"exectime"

HasValue

()) {

1825

exectime = args[

"exectime"

].AsDouble();

1834 if

(

"start_request"

) {

1837 m_Info

rid

= args[

"rid"

].AsInteger();

1845 string

params = args[

"param"

].AsString();

1853 if

(params.empty()) {

1856

params = extra +

"&"

+ params;

1867 if

(

"stop_request"

) {

1870 throw

std::runtime_error(

"Token string has wrong format (request token type expected)"

);

1872 int

status = args[

"status"

].AsInteger();

1873 int

n_read = args[

"input"

].AsInteger();

1874 int

n_write = args[

"output"

].AsInteger();

1882 if

(

"post"

) {

1883 string

sev = args[

"severity"

].AsString();

1884 string msg

= args[

"message"

].AsString();

1885 bool

note = args[

"note"

].AsBoolean();

1891 if

(sev ==

"trace"

) {

1899 else if

(sev ==

"info"

) {

1907 else if

(sev ==

"warning"

) {

1915 else if

(sev ==

"error"

) {

1923 else if

(sev ==

"critical"

) {

1937 if

(

"extra"

) {

1939 string

params = args[

"param"

].AsString();

1947 if

(