设置控制台内嵌参数调整内嵌页面的显示效果 - Simple Log Service: Central de Documentação do Alibaba Cloud

Observações

O console do Log Service é incorporado por meio de um iframe. Por padrão, as políticas de segurança do navegador bloqueiam recursos como abertura de novas janelas e download de logs. Para habilitar esses recursos, configure o atributo sandbox do iframe.

As políticas de segurança do navegador impedem que links dentro do iframe abram pop-ups. Para permitir pop-ups, adicione allow-popups ao atributo sandbox do iframe.
```
<iframe
  src="https://sls4service.console.alibabacloud.com/lognext/project/**..."
  sandbox="allow-scripts allow-popups"
/>
```
Essas políticas também bloqueiam downloads de logs. Para permitir downloads, adicione tanto allow-popups quanto allow-downloads ao atributo sandbox do iframe.
```
<iframe
  src="https://sls4service.console.alibabacloud.com/lognext/project/**..."
  sandbox="allow-scripts allow-popups allow-downloads"
/>
```

Formato da URL

Todos os parâmetros de UI são especificados na URL com o seguinte formato:

https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?parameter1&parameter2

Nota

Coloque todos os parâmetros, exceto ${ProjectName}, ${LogstoreName}, ${savedsearchID} e ${dashboardID}, após o ponto de interrogação (?) no final da URL.
Use o caractere "e" comercial (&) para separar múltiplos parâmetros.
Para usar o tema escuro, adicione theme=dark&sls_iframe=true à URL.
Os parâmetros de URL a seguir diferenciam maiúsculas de minúsculas.

Parâmetros comuns

Use parâmetros comuns para configurar o console.

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
hiddenBack	boolean	Não	Oculta o botão Voltar no console do projeto atual.	hiddenBack=true
hiddenChangeProject	boolean	Não	Oculta o controle de troca de projeto.	hiddenChangeProject=true
hiddenOverview	boolean	Não	Oculta o ponto de entrada para a visão geral do projeto.	hiddenOverview=true
hideSidebar	boolean	Não	Oculta o painel de navegação à esquerda.	hideSidebar=true
hideTopbar	boolean	Não	Oculta a barra de navegação superior.	hideTopbar=true
isShare	boolean	Não	Oculta o painel de navegação à esquerda e outras abas.	isShare=true
ignoreTabLocalStorage	boolean	Não	Desativa o histórico de navegação por abas.	ignoreTabLocalStorage=true
queryTimeType	long	Não	Intervalo de tempo para consulta e análise. Para mais informações, consulte queryTimeType values. 1 a 26: Intervalo de tempo predefinido identificado pelo valor inteiro correspondente. -2: Intervalo de tempo relativo personalizado. Requer os parâmetros start e end, por exemplo, start:-10m,end:now. -3: Período de tempo personalizado. Requer os parâmetros start e end, por exemplo, start:-2h,end:absolute. 99: Intervalo de tempo personalizado. Requer startTime e endTime como timestamps.	queryTimeType=1
startTime	timestamp	Não	Hora inicial do intervalo de tempo da consulta. Só tem efeito quando queryTimeType está definido como 99.	startTime=1547776643
endTime	timestamp	Não	Hora final do intervalo de tempo da consulta. Só tem efeito quando queryTimeType está definido como 99.	endTime=1547776731
disablePublicShare	boolean	Não	Oculta o botão Create Password-free Share em um painel.	disablePublicShare=true

Tabela 1. Valores de queryTimeType

queryTimeType	Descrição
1	1 minuto (relativo)
2	15 minutos (relativo)
3	1 hora (relativo)
4	4 horas (relativo)
5	1 dia (relativo)
6	1 semana (relativo)
7	30 dias (relativo)
8	1 minuto (período de tempo)
9	15 minutos (período de tempo)
10	1 hora (período de tempo)
11	4 horas (período de tempo)
12	1 dia (período de tempo)
13	1 semana (período de tempo)
14	30 dias (período de tempo)
15	Hoje (período de tempo)
16	Ontem (período de tempo)
17	Anteontem (período de tempo)
18	Esta semana (período de tempo)
19	Semana passada (período de tempo)
20	Este mês (período de tempo)
21	Este trimestre (período de tempo)
22	Hoje (relativo)
23	5 minutos (relativo)
24	Este ano (período de tempo)
25	Este mês (relativo)
26	Mês passado (período de tempo)
27	Esta semana (relativo)
28	5 minutos (período de tempo)
29	Ontem (relativo)
30	Anteontem (relativo)
31	Semana passada (relativo)
32	Mês passado (relativo)
33	Este trimestre (relativo)
34	Este ano (relativo)
99	Intervalo de tempo personalizado. Requer os parâmetros `startTime` e `endTime`.

Os exemplos a seguir mostram como usar parâmetros de URL:

Para ocultar o botão Voltar, o controle de troca de projeto e o ponto de entrada da visão geral do projeto, use a seguinte URL:

https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?hiddenBack=true&hiddenChangeProject=true&hiddenOverview=true

Para ocultar apenas o botão Voltar, use esta URL:

https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?hiddenBack=true

Para definir o intervalo de tempo para consulta e análise, utilize a URL abaixo:
```
https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?queryTimeType=3
```
Quando queryTimeType é definido como 3, o seletor de intervalo de tempo no canto superior direito da página de consulta exibe 1 hour (relative).

Parâmetros da página de consulta e análise do Logstore

Use os parâmetros a seguir para configurar a página de consulta e análise de um Logstore.

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectName	string	Sim	Nome do projeto.	website-01
LogstoreName	string	Sim	Nome do Logstore.	logstore01
queryString	string	Não	Instrução de consulta codificada em Base64. Por exemplo, a instrução de consulta`\|select count()` é codificada em Base64 como`KnxzZWxlY3QgY291bnQoKik=`.	KnxzZWxlY3QgY291bnQoKik=
readOnly	boolean	Não	Oculta elementos editáveis da UI, como Share, Index Attributes, Save as Saved Search e Save as Alert.	readOnly=true
encode	string	Não	Para evitar caracteres especiais no queryString, use `encode=base64`. O queryString será então uma string codificada em Base64.	encode=base64
hiddenEtl	boolean	Não	Oculta o botão de transformação de dados.	hiddenEtl=true
hiddenShare	boolean	Não	Oculta o botão Share.	hiddenShare=true
hiddenIndexSetting	boolean	Não	Oculta o botão de configuração de índice.	hiddenIndexSetting=true
hiddenSavedSearch	boolean	Não	Oculta o botão de pesquisa salva.	hiddenSavedSearch=true
hiddenAlert	boolean	Não	Oculta o botão de alerta.	hiddenAlert=true
hiddenQuickAnalysis	boolean	Não	Recolhe o painel Quick Analysis por padrão.	hiddenQuickAnalysis=true
hiddenDownload	boolean	Não	Oculta o recurso de download de logs.	hiddenDownload=true
hiddenModeSwitch	boolean	Não	Oculta o botão Dedicated SQL.	hiddenModeSwitch=true
keyDispalyMode	string	Não	Modo de exibição da coluna de conteúdo. `single`: Exibe cada log em uma única linha. `multi`: Quebra logs longos em várias linhas.	keyDispalyMode=single
hiddenLogChart	boolean	Não	Oculta a aba Graph.	hiddenLogChart=true
hiddenLogReduce	boolean	Não	Oculta a aba LogReduce.	hiddenLogReduce=true
hiddenColSetting	boolean	Não	Oculta a coluna de campos à esquerda.	hiddenColSetting=true
hiddenLogInspection	boolean	Não	Oculta a aba Intelligent Health Check.	hiddenLogInspection=true

Os exemplos a seguir demonstram o uso de parâmetros de URL:

Use a URL a seguir para especificar uma instrução de consulta.

Por exemplo, a instrução de consulta *|select count(*) é codificada em Base64 como KnxzZWxlY3QgY291bnQoKik=.
```
https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?encode=base64&queryString=KnxzZWxlY3QgY291bnQoKik=
```

Utilize a URL abaixo para ocultar elementos editáveis da UI, como Index Attributes e Save as Alert.

https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?readOnly=true

Aplique a seguinte URL para ocultar as abas Graph e LogReduce.
```
https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?hiddenLogChart=true&hiddenLogReduce=true
```
Com essas abas ocultas, a página de consulta e análise exibe apenas a aba de raw logs.

Parâmetros de pesquisa salva do LogStore

Use os parâmetros a seguir para personalizar uma página de pesquisa salva do LogStore.

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectName	string	Sim	Nome do projeto.	website-01
savedSearchName	string	Não	Nome da pesquisa salva.	quick-search01
savedsearchID	string	Sim	ID da pesquisa salva. Nota Após criar uma pesquisa salva, você pode obter seu ID na URL. Para mais informações, consulte Get a saved search ID.	savedsearch-1621845672511-314813

O exemplo a seguir mostra o formato da URL:

https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/savedsearch/${savedsearchID}

Esta URL abre a página da pesquisa salva especificada, como quick-search01, no projeto correspondente, como website-01. A página exibe a instrução de consulta salva, como *|select count(*), e fornece operações incluindo transformação de dados, propriedades de consulta e análise, salvar como alerta e modificar uma pesquisa salva.

Parâmetros de painel

Utilize os parâmetros a seguir para personalizar um painel.

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ProjectName	string	Sim	Nome do projeto.	website-01
dashboardName	string	Não	Nome do painel.	Website Analysis Logs
dashboardID	string	Sim	ID do painel. Nota Após criar um painel, você pode obter seu ID na URL. Para mais informações, consulte ListDashboard.	dashboard-1609817292009-742588
isShare	boolean	Não	Indica se o painel é visualizado por meio de um link de compartilhamento. Se definido como `true`, apenas a UI do painel é exibida e o botão Share fica oculto.	isShare=true
token	JsonString	Não	Token para substituição de variáveis. O valor deve ser codificado por URL com a função `encodeURIComponent()`. Por exemplo, `token=[{"key": "projectname","value":"1"}, {"key": "region", "value": "hangzhou"}]` é codificado como `token=%5B%7B%22key%22%3A%20%22projectname%22%2C%22value%22%3A%221%22%7D%2C%20%7B%22key%22%3A%20%22region%22%2C%20%22value%22%3A%20%22hangzhou%22%7D%5D`.	token=%5B%7B%22key%22%3A%20%22projectname%22%2C%22value%22%3A%221%22%7D%2C%20%7B%22key%22%3A%20%22region%22%2C%20%22value%22%3A%20%22hangzhou%22%7D%5D
readOnly	boolean	Não	Define se o modo somente leitura está ativado. Se definido como `true`, botões relacionados à edição, como Edit e Alerts, ficam ocultos.	readOnly=true
openPsql	boolean	Não	Define se o recurso Dedicated SQL está ativado.	openPsql=true
autoFresh	string	Não	Intervalo de atualização automática do painel, por exemplo, `30s` ou `5min`. O intervalo mínimo deve ser superior a 15s.	autoFresh=5m
filters	string	Não	Condições de filtro a serem aplicadas. O valor deve ser codificado por URL com a função `encodeURIComponent()`. Por exemplo, `filters=key1:value1&filters=key2:value2` é codificado como `filters=key1%3Avalue1%26filters%3Dkey2%3Avalue2`.	filters=key1%3Avalue1%26filters%3Dkey2%3Avalue2
hiddenFilter	boolean	Não	Oculta a seção Filter Conditions.	hiddenFilter=true
fixedFilter	boolean	Não	Impede a modificação ou exclusão de condições de filtro.	fixedFilter=true
disableFilterAndToken	boolean	Não	Desativa condições de filtro e substituição de variáveis.	disableFilterAndToken=true
fixedToken	boolean	Não	Impede a modificação ou exclusão de configurações de substituição de variáveis.	fixedToken=true
hiddenToken	boolean	Não	Oculta a seção Variable Replacement.	hiddenToken=true
hiddenProject	boolean	Não	Oculta informações do projeto.	hiddenProject=true
hiddenEdit	boolean	Não	Oculta o botão Edit.	hiddenEdit=true
hiddenReport	boolean	Não	Oculta o botão Subscribe.	hiddenReport=true
hiddenTitleSetting	boolean	Não	Oculta o botão Title Setting.	hiddenTitleSetting=true
hiddenReset	boolean	Não	Oculta o botão Reset Time.	hiddenReset=true
hiddenModeSwitch	boolean	Não	Oculta o botão Dedicated SQL.	hiddenModeSwitch=true
hiddenAlert	boolean	Não	Oculta a opção Save as Alert.	hiddenAlert=true
hiddenSearch	boolean	Não	Oculta a opção Preview Query.	hiddenSearch=true
hiddenShare	boolean	Não	Oculta o botão Share na barra superior. Este botão inclui as opções Share Link e Send Dashboard.	hiddenShare=true
hiddenPSql	boolean	Não	Oculta o botão Dedicated SQL.	hiddenPSql=true
hiddenFullScreen	boolean	Não	Oculta as opções de tela cheia (Monitor Full Screen e Window Full Screen) na barra superior.	hiddenFullScreen=true
hiddenSelectTime	boolean	Não	Oculta o seletor Time Range na barra superior.	hiddenSelectTime=true
hiddenChartTime	boolean	Não	Oculta a exibição do intervalo de tempo para gráficos individuais, que aparece após o título do gráfico.	hiddenChartTime=true
hiddenChartMenus	boolean	Não	Oculta o menu suspenso no canto superior direito de cada gráfico.	hiddenChartMenus=true
hiddenTitle	boolean	Não	Oculta o título do painel.	hiddenTitle=true
hiddenTopBar	boolean	Não	Oculta a barra superior do painel, que inclui o título e todos os botões de ação.	hiddenTopBar=true
hiddenCopy	boolean	Não	Oculta o botão Save as.	hiddenCopy=true
hiddenSurvey	boolean	Não	Oculta o ponto de entrada da pesquisa de satisfação.	hiddenSurvey=true
hiddenDrilldown	boolean	Não	Oculta a aba Drill-down no modo de edição do painel.	hiddenDrilldown=true
hiddenFieldConfig	boolean	Não	Oculta a aba Field Configuration no modo de edição do painel.	hiddenFieldConfig=true
disableViewChart	boolean	Não	Oculta a opção View para gráficos individuais.	disableViewChart=true

Os exemplos a seguir mostram como utilizar parâmetros de URL:

Para ativar o modo somente leitura em um painel, use a seguinte URL:
```
https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/dashboard/${dashboardID}?readOnly=true 
```
No modo somente leitura, a barra de ferramentas superior do painel exibe apenas botões relacionados à visualização, como Time Range, Refresh, Reset Time, Share, Full Screen e Subscribe. Os recursos de edição ficam indisponíveis.
Para adicionar duas condições de filtro, key1:value1 e key2:value2, a um painel, utilize a URL abaixo. A string da condição de filtro filters=key1:value1&filters=key2:value2 é codificada como filters%3Dkey1%3Avalue1%26filters%3Dkey2%3Avalue2.
```
https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/dashboard/${dashboardID}?filters%3Dkey1%3Avalue1%26filters%3Dkey2%3Avalue2
```
Após definir as condições de filtro, o painel exibe dados filtrados por key1:value1.
Para adicionar múltiplas condições de substituição de variáveis, como projectname=1, use a URL a seguir. Neste exemplo, token=[{"key": "projectname","value":"1"}, {"key": "region", "value": "hangzhou"}] é codificado como token=%5B%7B%22key%22%3A%20%22projectname%22%2C%22value%22%3A%221%22%7D%2C%20%7B%22key%22%3A%20%22region%22%2C%20%22value%22%3A%20%22hangzhou%22%7D%5D.
```
https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/dashboard/${dashboardID}?token=%5B%7B%22key%22%3A%20%22projectname%22%2C%22value%22%3A%221%22%7D%2C%20%7B%22key%22%3A%20%22region%22%2C%20%22value%22%3A%20%22hangzhou%22%7D%5D
```

Para atualizar automaticamente o painel a cada 5 minutos, aplique esta URL:

https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/dashboard/${dashboardID}?autoFresh=5m

Parâmetros de estrutura em árvore

Os parâmetros de estrutura em árvore configuram o painel de navegação à esquerda do console.

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

treeConfig

JSON

Não

Define a estrutura em árvore do painel de navegação à esquerda. Se você definir o parâmetro treeEncode como base64, o valor deste parâmetro deve ser codificado em Base64.

Por exemplo, {"logstore":{"expand":true,"resourceList":["delete-log"],"template":["savedsearch","alert"]}} é codificado em Base64 como eyJsb2dzdG9yZSI6eyJleHBhbmQiOnRydWUsInJlc291cmNlTGlzdCI6WyJkZWxldGUtbG9nIl0sInRlbXBsYXRlIjpbInNhdmVkc2VhcmNoIiwiYWxlcnQiXX19.

eyJsb2dzdG9yZSI6eyJleHBhbmQiOnRydWUsInJlc291cmNlTGlzdCI6WyJkZWxldGUtbG9nIl0sInRlbXBsYXRlIjpbInNhdmVkc2VhcmNoIiwiYWxlcnQiXX19

treeEncode

string

Não

Formato de codificação para o parâmetro treeConfig. O valor padrão é uma string vazia, indicando nenhuma codificação. A única codificação suportada é Base64.

treeEncode=base64

Segue um exemplo completo do parâmetro treeConfig:

{
    "logstore": { 
        "search": true, 
        "expand": true, 
        "resourceList": [ 
            "L1",
            "L2"
        ],
        "template": [
            "favor", 
            "logtail",
            "import", 
            "etl", 
            "savedsearch",
            "alert",
            "export", 
            "consumergroup", 
            "dashboard" 
        ]
    },
    "machineGroup": {
        "search": true,
        "resourceList": [
            "m1",
            "m2"
        ]
    },
    "savedSearch": {
        "search": true,
        "resourceList": [
            "s1",
            "s2"
        ]
    },
    "alarm": {
        "search": true,
        "resourceList": [
            "a1",
            "a2"
        ]
    },
    "dashboard": {
        "search": true,
        "resourceList": [
            "d1",
            "d2"
        ]
    },
    "etl": {
        "search": true,
        "resourceList": [
            "e1",
            "e2"
        ]
    }
}

Tabela 2. Parâmetros de treeConfig

Parâmetro	Tipo	Obrigatório	Descrição
logstore	object	Não	Controla as entradas de recursos na lista de Logstores.
template	string[]	Não	Controla as entradas de recursos na lista de Logstores. Para mais informações, consulte template parameter values.
machineGroup	object	Não	Controla as entradas de recursos na lista de grupos de máquinas.
savedSearch	object	Não	Controla as entradas de recursos na lista de pesquisas salvas.
alert	object	Não	Controla as entradas de recursos na lista de alertas.
dashboard	object	Não	Controla as entradas de recursos na lista de painéis.
etl	object	Não	Controla as entradas de recursos na lista de transformação de dados.

Tabela 3. Parâmetros relacionados a recursos

Parâmetro	Tipo	Obrigatório	Descrição
search	boolean	Não	Define se a caixa de pesquisa é exibida. Valor padrão: `true`.
resourceList	String[]	Não	Lista de recursos a serem exibidos. Apenas recursos cujos nomes correspondem exatamente a uma entrada neste array são mostrados. Se não configurado, todos os recursos do tipo correspondente são exibidos.
expand	boolean	Não	Define se a lista de recursos é expandida. Valor padrão: `false`. Este parâmetro aplica-se apenas à lista de Logstores.

Tabela 4. Parâmetros de template

Parâmetro	Tipo	Obrigatório	Descrição
favor	string	Não	watchlist
logtail	string	Não	Configuração do Logtail
import	string	Não	Importação de dados
etl	string	Não	Transformação de dados
savedsearch	string	Não	Pesquisa salva
alert	string	Não	Alerta
export	string	Não	Exportação de dados
consumergroup	string	Não	Consumo de dados
dashboard	string	Não	Painel

Use a seguinte URL para configurar o painel de navegação à esquerda:

https://sls4service.console.alibabacloud.com/lognext/project/${ProjectName}/logsearch/${LogstoreName}?treeconfig=eyJsb2dzdG9yZSI6eyJleHBhbmQiOnRydWUsInJlc291cmNlTGlzdCI6WyJkZWxldGUtbG9nIl0sInRlbXBsYXRlIjpbInNhdmVkc2VhcmNoIiwiYWxlcnQiXX19&hiddenBack=true&hiddenChangeProject=true&hiddenOverview=true&treeEncode=base64&ignoreTabLocalStorage=true

Após aplicar essa configuração, o painel de navegação à esquerda exibe o Logstore delete-log sob o projeto website-01. O Logstore é expandido para mostrar dois sub-recursos: pesquisa salva e alerta.

Parâmetros avançados de painel

Quando um painel é incorporado em um iframe, a altura do iframe não é definida automaticamente, o que pode criar duas barras de rolagem: uma para a página pai e outra para o painel. Use parâmetros avançados para fazer com que a altura do painel se ajuste dinamicamente.

É possível recuperar a altura do iframe da propriedade dashboardHeight, que o Simple Log Service passa em um evento postmessage. Exemplo:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>POST message test</title>
</head>
<style>
  * {
    padding: 0;
    margin: 0;
  }
  iframe {
    display: block;
    width: 100%;
  }
</style>
<body>
  <script>
    window.addEventListener('message',function(e){
      console.log(e.data.dashboardHeight)
      document.getElementById('test').style.height = e.data.dashboardHeight + 'px'
    });
  </script>
  <div style="height: 700px;">somethings</div>
  <iframe id="test" src="http://sls4service.console.alibabacloud.com/lognext/project/${projectName}/dashboard/${dashboardName}?product=${productCode}">
</body>
</html>