From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <d.tschlatscher@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by lists.proxmox.com (Postfix) with ESMTPS id 32844922A2;
Tue, 11 Oct 2022 16:00:32 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 180951DF6C;
Tue, 11 Oct 2022 16:00:02 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
[94.136.29.106])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by firstgate.proxmox.com (Proxmox) with ESMTPS;
Tue, 11 Oct 2022 16:00:00 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
by proxmox-new.maurer-it.com (Proxmox) with ESMTP id E701944948;
Tue, 11 Oct 2022 15:59:53 +0200 (CEST)
From: Daniel Tschlatscher <d.tschlatscher@proxmox.com>
To: pve-devel@lists.proxmox.com, pbs-devel@lists.proxmox.com,
pmg-devel@lists.proxmox.com
Date: Tue, 11 Oct 2022 15:59:01 +0200
Message-Id: <20221011135902.610515-3-d.tschlatscher@proxmox.com>
X-Mailer: git-send-email 2.30.2
In-Reply-To: <20221011135902.610515-1-d.tschlatscher@proxmox.com>
References: <20221011135902.610515-1-d.tschlatscher@proxmox.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.161 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
information. [tasks.pm]
Subject: [pve-devel] [PATCH pmg-api v3] make tasklog downloadable in the PMG
backend
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Tue, 11 Oct 2022 14:00:32 -0000
The read tasklog API call now streams the log file if the limit
parameter is set to 0. If not, it should behave the same as before.
This is done in preparation for the task log download button to be
added in the TaskViewer.
I saw an opportunity here to clear some redundant code for displaying
the tasklog and replaced it with a call to dump_logfile(), akin to how
this is handled in pve-manager.
Signed-off-by: Daniel Tschlatscher <d.tschlatscher@proxmox.com>
---
changes from v2
* replaced helper call with inline implementation
* changed compression cutoff to 1024
* replaced stat($filename)→size call with "-s"
src/PMG/API2/Tasks.pm | 43 ++++++++++++++++++++++++-------------------
1 file changed, 24 insertions(+), 19 deletions(-)
diff --git a/src/PMG/API2/Tasks.pm b/src/PMG/API2/Tasks.pm
index 598fb4d..da53f48 100644
--- a/src/PMG/API2/Tasks.pm
+++ b/src/PMG/API2/Tasks.pm
@@ -243,6 +243,7 @@ __PACKAGE__->register_method({
type => 'integer',
minimum => 0,
optional => 1,
+ description => "The maximum amount of lines that should be printed. A limit of 0 streams the file directly, otherwise lines are json encoded.",
},
},
},
@@ -272,30 +273,34 @@ __PACKAGE__->register_method({
my $restenv = PMG::RESTEnvironment->get();
- my $fh = IO::File->new($filename, "r");
- raise_param_exc({ upid => "no such task - unable to open file - $!" }) if !$fh;
+ my $start = $param->{start} // 0;
+ my $limit = $param->{limit} // 50;
- my $start = $param->{start} || 0;
- my $limit = $param->{limit} || 50;
- my $count = 0;
- my $line;
- while (defined ($line = <$fh>)) {
- next if $count++ < $start;
- next if $limit <= 0;
- chomp $line;
- push @$lines, { n => $count, t => $line};
- $limit--;
- }
+ if ($limit == 0) {
+ # 1024 is a practical cutoff for the size distribution of our log files.
+ my $use_compression = ( -s $filename ) > 1024;
- close($fh);
+ my $fh;
+ if ($use_compression) {
+ open($fh, "-|", "/usr/bin/gzip", "-c", "$filename")
+ or die "Could not create compressed file stream for $filename - $!";
+ } else {
+ open($fh, '<', $filename) or die "Could not open file $filename - $!";
+ }
- # HACK: ExtJS store.guaranteeRange() does not like empty array
- # so we add a line
- if (!$count) {
- $count++;
- push @$lines, { n => $count, t => "no content"};
+ return {
+ download => {
+ fh => $fh,
+ stream => 1,
+ 'content-encoding' => $use_compression ? 'gzip' : undef,
+ 'content-type' => "text/plain",
+ 'content-disposition' => "attachment; filename=\"".$param->{upid}."\"",
+ },
+ },
}
+ my ($count, $lines) = PVE::Tools::dump_logfile($filename, $start, $limit);
+
$restenv->set_result_attrib('total', $count);
return $lines;
--
2.30.2
From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <d.tschlatscher@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by lists.proxmox.com (Postfix) with ESMTPS id 32844922A2;
Tue, 11 Oct 2022 16:00:32 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 180951DF6C;
Tue, 11 Oct 2022 16:00:02 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
[94.136.29.106])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by firstgate.proxmox.com (Proxmox) with ESMTPS;
Tue, 11 Oct 2022 16:00:00 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
by proxmox-new.maurer-it.com (Proxmox) with ESMTP id E701944948;
Tue, 11 Oct 2022 15:59:53 +0200 (CEST)
From: Daniel Tschlatscher <d.tschlatscher@proxmox.com>
To: pve-devel@lists.proxmox.com, pbs-devel@lists.proxmox.com,
pmg-devel@lists.proxmox.com
Date: Tue, 11 Oct 2022 15:59:01 +0200
Message-Id: <20221011135902.610515-3-d.tschlatscher@proxmox.com>
X-Mailer: git-send-email 2.30.2
In-Reply-To: <20221011135902.610515-1-d.tschlatscher@proxmox.com>
References: <20221011135902.610515-1-d.tschlatscher@proxmox.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.161 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
information. [tasks.pm]
Subject: [pbs-devel] [PATCH pmg-api v3] make tasklog downloadable in the PMG
backend
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
<pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Tue, 11 Oct 2022 14:00:32 -0000
The read tasklog API call now streams the log file if the limit
parameter is set to 0. If not, it should behave the same as before.
This is done in preparation for the task log download button to be
added in the TaskViewer.
I saw an opportunity here to clear some redundant code for displaying
the tasklog and replaced it with a call to dump_logfile(), akin to how
this is handled in pve-manager.
Signed-off-by: Daniel Tschlatscher <d.tschlatscher@proxmox.com>
---
changes from v2
* replaced helper call with inline implementation
* changed compression cutoff to 1024
* replaced stat($filename)→size call with "-s"
src/PMG/API2/Tasks.pm | 43 ++++++++++++++++++++++++-------------------
1 file changed, 24 insertions(+), 19 deletions(-)
diff --git a/src/PMG/API2/Tasks.pm b/src/PMG/API2/Tasks.pm
index 598fb4d..da53f48 100644
--- a/src/PMG/API2/Tasks.pm
+++ b/src/PMG/API2/Tasks.pm
@@ -243,6 +243,7 @@ __PACKAGE__->register_method({
type => 'integer',
minimum => 0,
optional => 1,
+ description => "The maximum amount of lines that should be printed. A limit of 0 streams the file directly, otherwise lines are json encoded.",
},
},
},
@@ -272,30 +273,34 @@ __PACKAGE__->register_method({
my $restenv = PMG::RESTEnvironment->get();
- my $fh = IO::File->new($filename, "r");
- raise_param_exc({ upid => "no such task - unable to open file - $!" }) if !$fh;
+ my $start = $param->{start} // 0;
+ my $limit = $param->{limit} // 50;
- my $start = $param->{start} || 0;
- my $limit = $param->{limit} || 50;
- my $count = 0;
- my $line;
- while (defined ($line = <$fh>)) {
- next if $count++ < $start;
- next if $limit <= 0;
- chomp $line;
- push @$lines, { n => $count, t => $line};
- $limit--;
- }
+ if ($limit == 0) {
+ # 1024 is a practical cutoff for the size distribution of our log files.
+ my $use_compression = ( -s $filename ) > 1024;
- close($fh);
+ my $fh;
+ if ($use_compression) {
+ open($fh, "-|", "/usr/bin/gzip", "-c", "$filename")
+ or die "Could not create compressed file stream for $filename - $!";
+ } else {
+ open($fh, '<', $filename) or die "Could not open file $filename - $!";
+ }
- # HACK: ExtJS store.guaranteeRange() does not like empty array
- # so we add a line
- if (!$count) {
- $count++;
- push @$lines, { n => $count, t => "no content"};
+ return {
+ download => {
+ fh => $fh,
+ stream => 1,
+ 'content-encoding' => $use_compression ? 'gzip' : undef,
+ 'content-type' => "text/plain",
+ 'content-disposition' => "attachment; filename=\"".$param->{upid}."\"",
+ },
+ },
}
+ my ($count, $lines) = PVE::Tools::dump_logfile($filename, $start, $limit);
+
$restenv->set_result_attrib('total', $count);
return $lines;
--
2.30.2
From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <d.tschlatscher@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by lists.proxmox.com (Postfix) with ESMTPS id 32844922A2;
Tue, 11 Oct 2022 16:00:32 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 180951DF6C;
Tue, 11 Oct 2022 16:00:02 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
[94.136.29.106])
(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
key-exchange X25519 server-signature RSA-PSS (2048 bits))
(No client certificate requested)
by firstgate.proxmox.com (Proxmox) with ESMTPS;
Tue, 11 Oct 2022 16:00:00 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
by proxmox-new.maurer-it.com (Proxmox) with ESMTP id E701944948;
Tue, 11 Oct 2022 15:59:53 +0200 (CEST)
From: Daniel Tschlatscher <d.tschlatscher@proxmox.com>
To: pve-devel@lists.proxmox.com, pbs-devel@lists.proxmox.com,
pmg-devel@lists.proxmox.com
Date: Tue, 11 Oct 2022 15:59:01 +0200
Message-Id: <20221011135902.610515-3-d.tschlatscher@proxmox.com>
X-Mailer: git-send-email 2.30.2
In-Reply-To: <20221011135902.610515-1-d.tschlatscher@proxmox.com>
References: <20221011135902.610515-1-d.tschlatscher@proxmox.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.161 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record
SPF_PASS -0.001 SPF: sender matches SPF record
URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
information. [tasks.pm]
Subject: [pmg-devel] [PATCH pmg-api v3] make tasklog downloadable in the PMG
backend
X-BeenThere: pmg-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Mail Gateway development discussion
<pmg-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pmg-devel>,
<mailto:pmg-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pmg-devel/>
List-Post: <mailto:pmg-devel@lists.proxmox.com>
List-Help: <mailto:pmg-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pmg-devel>,
<mailto:pmg-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Tue, 11 Oct 2022 14:00:32 -0000
The read tasklog API call now streams the log file if the limit
parameter is set to 0. If not, it should behave the same as before.
This is done in preparation for the task log download button to be
added in the TaskViewer.
I saw an opportunity here to clear some redundant code for displaying
the tasklog and replaced it with a call to dump_logfile(), akin to how
this is handled in pve-manager.
Signed-off-by: Daniel Tschlatscher <d.tschlatscher@proxmox.com>
---
changes from v2
* replaced helper call with inline implementation
* changed compression cutoff to 1024
* replaced stat($filename)→size call with "-s"
src/PMG/API2/Tasks.pm | 43 ++++++++++++++++++++++++-------------------
1 file changed, 24 insertions(+), 19 deletions(-)
diff --git a/src/PMG/API2/Tasks.pm b/src/PMG/API2/Tasks.pm
index 598fb4d..da53f48 100644
--- a/src/PMG/API2/Tasks.pm
+++ b/src/PMG/API2/Tasks.pm
@@ -243,6 +243,7 @@ __PACKAGE__->register_method({
type => 'integer',
minimum => 0,
optional => 1,
+ description => "The maximum amount of lines that should be printed. A limit of 0 streams the file directly, otherwise lines are json encoded.",
},
},
},
@@ -272,30 +273,34 @@ __PACKAGE__->register_method({
my $restenv = PMG::RESTEnvironment->get();
- my $fh = IO::File->new($filename, "r");
- raise_param_exc({ upid => "no such task - unable to open file - $!" }) if !$fh;
+ my $start = $param->{start} // 0;
+ my $limit = $param->{limit} // 50;
- my $start = $param->{start} || 0;
- my $limit = $param->{limit} || 50;
- my $count = 0;
- my $line;
- while (defined ($line = <$fh>)) {
- next if $count++ < $start;
- next if $limit <= 0;
- chomp $line;
- push @$lines, { n => $count, t => $line};
- $limit--;
- }
+ if ($limit == 0) {
+ # 1024 is a practical cutoff for the size distribution of our log files.
+ my $use_compression = ( -s $filename ) > 1024;
- close($fh);
+ my $fh;
+ if ($use_compression) {
+ open($fh, "-|", "/usr/bin/gzip", "-c", "$filename")
+ or die "Could not create compressed file stream for $filename - $!";
+ } else {
+ open($fh, '<', $filename) or die "Could not open file $filename - $!";
+ }
- # HACK: ExtJS store.guaranteeRange() does not like empty array
- # so we add a line
- if (!$count) {
- $count++;
- push @$lines, { n => $count, t => "no content"};
+ return {
+ download => {
+ fh => $fh,
+ stream => 1,
+ 'content-encoding' => $use_compression ? 'gzip' : undef,
+ 'content-type' => "text/plain",
+ 'content-disposition' => "attachment; filename=\"".$param->{upid}."\"",
+ },
+ },
}
+ my ($count, $lines) = PVE::Tools::dump_logfile($filename, $start, $limit);
+
$restenv->set_result_attrib('total', $count);
return $lines;
--
2.30.2