Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Logs
HTML
    <div style="width: 90%; margin: 20px auto; text-align: center;">
        <div style="width: 100%; max-height: 200px; overflow: hidden; margin: 0 auto;">
            <img src="https://i.postimg.cc/8zv25mb2/GIFuniverso-TOTVS.gif" alt="Universo TOTVS GIF" style="max-width: 100%; height: auto;">
        </div>
    </div>

    <div style="width: 90%; margin: 20px auto; text-align: center; margin-top: 50px;background-color: #f5f5f5;">
        <h2 style="margin-bottom: 20px; font-size: 24px; margin-top: 20px;">Palestrantes</h2>

<div style="display: inline-block;">
    <div style="display: inline-block; text-align: center; margin-right: 20px;">
        <img src="https://i.postimg.cc/28g5MT6M/juliano-Foto.png" alt="Palestrante 1 - Juliano" style="width: 100px; height: 100px; border-radius: 50%; margin-bottom: 5px; object-fit: cover;">
        <p>Juliano Gontarski</p>
    </div>
    <div style="display: inline-block; text-align: center;">
        <img src="https://i.postimg.cc/8kJcHqkM/silvano-Foto.png" alt="Palestrante 2 - Silvano" style="width: 100px; height: 100px; border-radius: 50%; margin-bottom: 5px; object-fit: cover;">
        <p>Silvano Rocha</p>
    </div>
</div>


    </div>   Vamos revisar alguns fatores, parâmetros e diretrizes que podem transformar a jornada com o Fluig em uma viagem tranquila, minimizando imprevistos com ações simples e eficientes <div style="margin-top: 50px;">     
 <h1 style="position: relative;">
        <span style="float: left; margin-right: 10px; width: 30px; height: 30px; border-radius: 50%; background-color: #6b48ff; color: white; text-align: center; line-height: 30px;">1</span>
        Saindo das <span style="color: #6b48ff;">configurações padrão</span>
    </h1> 
     <h3 style="width: 90%; margin: 10px auto; margin-top: 5px;">Pequenos ajustes para sair ‘da caixinha’</h3>
</div>


 Algumas Configurações básicas costumam ficar esquecidas:



  • Quantidade de Conexões do Fluig com o Banco de Dados (FluigDS, FluigDSRO e Customs)

    Não existe uma configuração padrão para o número de conexões com o banco pois cada forma de uso da Plataforma pode demandar mais ou menos conexões, mas para sair da caixinha - ou sair das configurações padrão do instalador - pode-se ajustar inicialmente o max-pool-size para 300 em cada um dos Datasources.

    Para casos onde a demanda de uso é grande, pode ser necessário um ajuste fino nestes parâmetros, ou ainda considerar um crescimento horizontal da Infraestrutura. Falaremos sobre Load Balance mais à frente.

    O TOTVS Fluig por padrão tem configurados no arquivo domain.xml 3 Datasources para atender às diversas necessidades operacionais. Sendo eles FluigDS FluigDSRO de uso exclusivo da Plataforma e AppDS que é voltado para uso em customizados. Abaixo um exemplo de configuração sugerida para estes Datasources:


Bloco de código
languagexml
themeRDark
titleFluigDS - domain.xml
   <datasource jta="true" jndi-name="java:/jdbc/FluigDS" pool-name="FluigDS" enabled="true" use-java-context="false">
        <connection-url>jdbc:mysql://localhost:3306/fluig_mysql?useSSL=false&nullDatabaseMeansCurrent=true</connection-url>
        <driver>mysqlDriver</driver>
        <transaction-isolation>TRANSACTION_READ_COMMITTED</transaction-isolation>
        <pool>
            <min-pool-size>10</min-pool-size>
            <max-pool-size>300</max-pool-size>
 ...
    </datasource>
Bloco de código
languagexml
themeRDark
titleFluigDSRO - domain.xml
    <datasource jta="false" jndi-name="java:/jdbc/FluigDSRO" pool-name="FluigDSRO" enabled="true" use-java-context="false">
        <connection-url>jdbc:mysql://localhost:3306/fluig_mysql?useSSL=false&nullDatabaseMeansCurrent=true</connection-url>
        <driver>mysqlDriver</driver>
        <transaction-isolation>TRANSACTION_READ_COMMITTED</transaction-isolation>
        <pool>
            <min-pool-size>5</min-pool-size>
            <max-pool-size>300</max-pool-size>
...
    </datasource>
Bloco de código
languagexml
themeRDark
titleAppDS - domain.xml
<datasource enabled="true" jndi-name="java:/jdbc/AppDS" jta="false" pool-name="AppDS" statistics-enabled="true" use-java-context="false">
        <connection-url>jdbc:mysql://localhost:3306/fluig_mysql?useSSL=false&nullDatabaseMeansCurrent=true</connection-url>
        <driver>mysqlDriver</driver>
        <transaction-isolation>TRANSACTION_READ_COMMITTED</transaction-isolation>
        <pool>
            <min-pool-size>5</min-pool-size>
            <max-pool-size>300</max-pool-size>
...
    </datasource>



           O arquivo domain.xml pode ser encontrado no seguinte caminho: <diretório de instalação do Fluig>\appserver\domain\configuration\domain.xml. A quantidade máxima de conexões pode ser ajustada no parâmetro <max-pool-size>.

Sempre realize um Backup do arquivo domain.xml antes de realizar alterações.
As alterações serão aplicadas somente após a reinicialização da Plataforma.

  • Adequação das Filas Assíncronas

Tal como no Banco de Dados, não existe uma configuração padrão para as Filas Assíncronas da Plataforma. Entretanto, alguns ajustes simples podem trazer uma melhor entrega do serviço sem um aumento considerável no consumo de recursos do servidor;
Abaixo, listo uma sugestão de parametrização que costuma atender a maioria dos casos de forma satisfatória:

Bloco de código
languagexml
themeRDark
titleFilas Assíncronas - domain.xml
            	 <pools>
                    <bean-instance-pools>
                        <strict-max-pool instance-acquisition-timeout="30" instance-acquisition-timeout-unit="MINUTES" max-pool-size="50" name="slsb-strict-max-pool"/>
                        <strict-max-pool instance-acquisition-timeout="30" instance-acquisition-timeout-unit="MINUTES" max-pool-size="50" name="permission-ejb-pool"/>
                        <strict-max-pool instance-acquisition-timeout="30" instance-acquisition-timeout-unit="MINUTES" max-pool-size="50" name="mdb-strict-max-pool"/>
                        <strict-max-pool instance-acquisition-timeout="3" instance-acquisition-timeout-unit="MINUTES" max-pool-size="1" name="mdb-strict-single-pool"/>
                        <strict-max-pool instance-acquisition-timeout="30" instance-acquisition-timeout-unit="MINUTES" max-pool-size="1" name="mdb-deploy-max-pool"/>
                        <strict-max-pool instance-acquisition-timeout="30" instance-acquisition-timeout-unit="MINUTES" max-pool-size="60" name="mdb-strict-multi-pool"/>
                        <strict-max-pool instance-acquisition-timeout="5" instance-acquisition-timeout-unit="MINUTES" max-pool-size="5" name="mdb-page-max-pool"/>
                    </bean-instance-pools>
                </pools>

O arquivo domain.xml pode ser encontrado no seguinte caminho: <diretório de instalação do Fluig>\appserver\domain\configuration\domain.xml.
Sempre realize um Backup do arquivo domain.xml antes de realizar alterações.
As alterações serão aplicadas somente após a reinicialização da Plataforma.

  • Ajuste deMemória (XMX, MetaSpace)

Por padrão. as configurações de memória que o instalador fornece são:

size="2g" (memória inicial de consumo)

max-size="4g" (máximo a ser consumido)

Para um ambiente de desenvolvimento local, muitas vezes estes parâmetros são suficientes. Porém, para um ambiente de homologação ou produção, é necessário alterar esses valores.

Esta alteração é feita no arquivo host.xml, que pode ser localizado em: <diretório de instalação do Fluig>\appserver\domain\configuration\host.xml.

Não é recomendado alterar a quantidade inicial (mínima) de memória alocada (size="2g"), pois a plataforma alocará memória de acordo com a necessidade sem que ultrapasse o valor máximo declarado em max-size, podendo retornar até o valor mínimo sempre que a demanda de uso da plataforma diminuir.

Portanto, na tag <heap> o parâmetro a ser ajustado é o 'max-size'.
Nos testes de performance realizados pela equipe de produto, o melhor valor para este parâmetro é 12g, sendo que acima deste valor não há ganho real de performance. Falaremos mais sobre como ir além deste ponto no tópico seguinte 'Dimensionamento'.

Além disto, recomenda-se também ampliar o valor do parâmetro MaxMetaspaceSize, de 1024m (1g) para 2g, conforme exemplo abaixo:

Bloco de código
languagexml
themeRDark
titleAjuste de Memória - host.xml
 <server auto-start="true" group="fluig" name="fluig1">
            <jvm name="default">
                <heap max-size="12g" size="2g"/>
                <jvm-options>
                    <option value="-Dfile.encoding=utf8"/>
                    <option value="-XX:MaxMetaspaceSize=2g"/>
                    <option value="-Djavamelody.disabled=true"/>
...</server>

Esta parametrização sugerida faz um bom uso dos recursos de memória, sem desperdiçar ou alocar recursos que serão utilizadas de forma não otimizada.

É importante garantir que o servidor tenha memória suficiente para suportar esta configuração.
Tenha em mente que o Sistema operacional também consome memória, então para o ajuste sugerido, deve haver pelo menos 18g de memória instalada no servidor (12g + 2g + 4g para o S.O.).
Na documentação Modelo de dimensionamento podem ser encontrados mais detalhes e recomendações sobre o assunto.

Sempre realize um Backup do arquivo host.xml antes de realizar alterações.
As alterações serão aplicadas somente após a reinicialização da Plataforma.


  • Limite de Arquivos do Linux e parametrizações que dependem do Sistema Operacional, como permissões e liberações de Firewall


A instalação do Fluig depende diretamente do comportamento de das parametrizações do S.O. e da Topologia de Rede em que esteja sendo executado, portanto alguns detalhes devem ser verificados, listamos alguns abaixo:

-Permissionamento no sistema de arquivos:
Garanta que o serviço Fluig seja Owner do diretório da instalação, bem como do Volume da plataforma;

-Liberação em Firewall:
Por se tratar de uma aplicação onLine, é imprescindível garantir que as portas e endereços envolvidos estejam com a correta liberação. Consulte Portas e endereços para mais detalhes;

-Caso o servidor seja Linux, recomendamos visitar a documentação de
Configurações sugeridas em ambientes Linux para o perfeito funcionamento neste S.O.




HTML
<div style="margin-top: 50px;">
     <h1 style="position: relative;">
        <span style="float: left; margin-right: 10px; width: 30px; height: 30px; border-radius: 50%; background-color: #6b48ff; color: white; text-align: center; line-height: 30px;">2</span>
        Dimensionamento
    </h1> 
    <h3 style="width: 90%; margin: 20px auto; margin-top: 5px;">Observar as demandas e responsabilidades atribuídas à Plataforma, e trabalhar com uma entrega coerente de disponibilidade de serviço</h3>
</div>



  • Crescimento Horizontal x Vertical

Após atingir o limite de memória no ajuste das parametrizações padrão, que vimos no tópico anterior, o Crescimento da entrega de disponibilidade de serviço deve ser planejado de forma Horizontal.

Ou seja, se a demanda aumenta, ao invés de ultrapassar o limite recomendado de máximo de memória para o serviço Fluig devem ser disponibilizados mais servidores em paralelo, implementando o Balanceamento de Carga.

Para implementar da forma correta, recomendamos avaliar as documentações Modelo de dimensionamento e Alta disponibilidade e Balanceamento de carga, que trazem as diretrizes recomendadas para esta implementação.

  • Demanda Uso x Quantidade de Nós (capacidade de processamento) 

A partir de 100 usuários acessando a plataforma em paralelo já é recomendada a implementação do Balanceamento de Carga com pelo menos dois Servidores Fluig. 
Mesmo com menos usuários, é uma boa prática projetar este crescimento, avaliando possíveis projetos futuros e pavimentando o caminho para que a implementação do Balanceamento seja realizada.

Além do Balanceamento de Carga, ferramentas como o Apache e NGinx podem atuar como um Proxy Reverso, atuando como uma camada extra de segurança, e ampliando a maturidade da sua topologia de rede.
Para mais dicas de segurança, visite também Técnicas para dar mais segurança à sua plataforma TOTVS Fluig: 5 dicas práticas

  • Avaliar as Demandas de integração para adequar a entrega de disponibilidade

Muitas vezes observamos o acesso realizado por usuários físicos, mas desconsideramos que as integrações de entrada (ERP e sistemas terceiros) e integrações de saída (Datasets sincronizados, Chamadas de webservices, etc) também demandam recursos computacionais.
Sempre considere estas demandas ao realizar o dimensionamento da Plataforma, para evitar impactos aos usuários físicos e garantir uma entrega de qualidade no serviço da Plataforma.



HTML
<div style="margin-top: 50px;">
     <h1 style="position: relative;">
        <span style="float: left; margin-right: 10px; width: 30px; height: 30px; border-radius: 50%; background-color: #6b48ff; color: white; text-align: center; line-height: 30px;">3</span>
Otimização dos Dados da Plataforma
</h1> 
    <h3 style="width: 90%; margin: 20px auto; margin-top: 5px;">Ferramentas nativas do Fluig para uso rotineiro, e algumas dicas extras</h3>
</div>



  • Limpeza de Notificações, Limpeza de Lixeira e Compactação de Solicitações

Algumas ações básicas podem ser feitas utilizando a ferramenta nativa embarcada na plataforma, e trazem vantagens para manutenção de dados a longo prazo;
Verifique Plataforma ❙ Agendador de tarefas e avalie como estão suas configurações de Limpeza de Notificações, limpeza de Lixeira e Compactação de Solicitações.

Estas ações visam otimizar dados das tabelas e expurgar informações que não precisam mais ocupar espaço em Banco de Dados. Mais detalhes sobre cada um dos tópicos podem ser encontrados na documentação oficial.



  • Avaliar documentos  nunca acessados

Bloco de código
languagesql
themeRDark
titleSQL - Documentos nunca acessados
/* Anexos de processos nunca acessados */

SELECT nr_versao, nr_documento, nm_arquivo_fisico, num_tam_arq_fisic FROM documento d WHERE nr_acessos = 0 AND tp_documento=7 OR (tp_documento=2 AND EXISTS(SELECT ap.NR_DOCUMENTO FROM anexo_proces ap WHERE ap.NR_DOCUMENTO = d.NR_DOCUMENTO) ) ORDER BY num_tam_arq_fisic DESC, nr_documento DESC

/* Documentos que não são anexos de processos, nunca acessados */

SELECT nr_versao, nr_documento, nm_arquivo_fisico, num_tam_arq_fisic FROM documento d WHERE nr_acessos = 0 AND tp_documento=2 AND not EXISTS(SELECT ap.NR_DOCUMENTO FROM anexo_proces ap WHERE ap.NR_DOCUMENTO = d.NR_DOCUMENTO ) ORDER BY num_tam_arq_fisic DESC, nr_documento DESC
Nunca elimine informações diretamente das tabelas da plataforma.

Os documentos que forem identificados para eliminação devem ser eliminados através da Navegação de Documentos, ou das APIs Públicas de manutenção de Documentos.

  • Avaliar documentos com validade expirada

Bloco de código
languagesql
themeRDark
titleSQL - Documentos nunca acessados
/* documentos com a data de expiração menor do que a data atual */
SELECT distinct(nr_documento) FROM documento WHERE dt_expiracao < CURDATE() 
Nunca elimine informações diretamente das tabelas da plataforma.

Os documentos que forem identificados para eliminação devem ser eliminados através da Navegação de Documentos, ou das APIs Públicas de manutenção de Documentos.

  • Expurgo da tabela fdn_accesslog

A tabela fdn_accesslog registra todas as tentativas de login com erro, com sucesso e logout da Plataforma.
Os dados desta tabela podem servir para auditoria de acesso, mas após extraídos relatórios e informações relevantes, as informações podem ser apagadas da tabela para diminuir o volume de dados do Banco de Dados.

Bloco de código
languagesql
themeRDark
titleSQL - Documentos nunca acessados
/*
 log_type:
0 - LOGIN, 
1 - LOGINERROR, 
2 - LOGOUT

access_date
Data no formato 'YYYY-MM-DD HH:mm:ss'
*/
SELECT * FROM fdn_accesslog

Diferente de outras tabelas da plataforma, a tabela fdn_accesslog pode ter dados eliminados diretamente no banco de dados.



HTML
<div style="margin-top: 50px;">
     <h1 style="position: relative;">
        <span style="float: left; margin-right: 10px; width: 30px; height: 30px; border-radius: 50%; background-color: #6b48ff; color: white; text-align: center; line-height: 30px;">4</span>
Chamadas de Serviço Padronizadas
</h1> 
    <h3 style="width: 90%; margin: 20px auto; margin-top: 5px;">A interface de integração da Plataforma é completa e segura</h3>
</div>
  • Sempre consumir APIs documentadas

Nas integrações com aplicações externas e APIs da Plataforma, é importante garantir que ocorram de forma segura e confiável.

As APIs documentadas são uma forma de 'contrato', onde a documentação da API garante que a assinatura seguirá coerente ao longo das atualizações das Plataformas. 

  • Usar o Cadastro de Serviços como Interface de Integração 

O Cadastro de Serviços da Plataforma traz diversas vantagens, como por exemplo a rastreabilidade do número total de chamadas, bem como a diferenciação das chamadas com sucesso e as que retornaram erro, em cada API cadastrada.

Além disso, nas APIs configuradas é possível consultar um Log detalhado destas tentativas de integração.
Consulte a documentação Plataforma ❙ Serviços para avaliar todas as funcionalidades.

  • Tirar proveito da Modernização e Evolução constantes da interface da Plataforma

Utilizar as interfaces da Plataforma para implementar suas integrações garante que, caso surjam novas ferramentas, Melhorias e correções, você seja contemplado sem maiores esforços.

Uma recomendação é sempre complementar o seu desenvolvimento de integrações avaliando a performance de APIs fora do contexto da Plataforma, utilizando ferramentas como PostMan para observar o comportamento das APIs isoladamente.



HTML
<div style="margin-top: 50px;">
     <h1 style="position: relative;">
        <span style="float: left; margin-right: 10px; width: 30px; height: 30px; border-radius: 50%; background-color: #6b48ff; color: white; text-align: center; line-height: 30px;">5</span>
Controles de logs
</h1> 
    <h3 style="width: 90%; margin: 20px auto; margin-top: 5px;">Um dos Maiores Aliados do desenvolvedor</h3>
</div>
  • Log de chamadas de Serviço - Request x Response

Tão importante quanto fazer um desenvolvimento bem feito, é ter um acompanhamento dessas chamadas.
O Log das chamadas de Serviço é uma interface complementar ao Log Principal da plataforma, Nichado para rastrear as interações com algum serviço específico cadastrado na Plataforma.

  • Log Principal - server.log

Tempos e Detalhes de execução de Serviços, Dataset e Eventos da Plataforma. Confira também Plataforma ❙ Controle de log

  • Log Por Usuário

Log específico para as ações realizadas na Sessão de um usuário específico. Muito útil para isolar e avaliar comportamentos inesperados reportados por usuários da plataforma. Confira também Controle de Log

  • API de monitoramento de tempos de Execução

API com a listagem dos tempos médios em Milissegundos de execuções das APIs e ferramentas internas da Plataforma. 
Acessar a URL abaixo com um usuário Administrador:

[URL Flig]/api/public/wcm/chronos/meanTimes

Image Added




HTML
<div style="margin-top: 50px;">
     <h1 style="position: relative;">
        <span style="float: left; margin-right: 10px; width: 30px; height: 30px; border-radius: 50%; background-color: #6b48ff; color: white; text-align: center; line-height: 30px;">6</span>
Cuidados durante a construção de Processos
</h1> 
    <h3 style="width: 90%; margin: 20px auto; margin-top: 5px;">Quando pequenos detalhes mudam tudo</h3>
</div>




HTML
<div style="margin-top: 50px;">
     <h1 style="position: relative;">
        <span style="float: left; margin-right: 10px; width: 30px; height: 30px; border-radius: 50%; background-color: #6b48ff; color: white; text-align: center; line-height: 30px;">7</span>
Página Home
</h1> 
    <h3 style="width: 90%; margin: 20px auto; margin-top: 5px;">Uma boa experiência na Plataforma inicia com um bom primeiro passo;
A página inicial deve ser leve, rápida e objetiva</h3>
</div>



HTML
<div style="margin-top: 50px;">
     <h1 style="position: relative;">
        <span style="float: left; margin-right: 10px; width: 30px; height: 30px; border-radius: 50%; background-color: #6b48ff; color: white; text-align: center; line-height: 30px;">8</span>
Integração Assíncrona
</h1> 
    <h3 style="width: 90%; margin: 20px auto; margin-top: 5px;">A Maioria das Integrações pode ocorrer enquanto o usuário se ocupa com outras tarefas</h3>
</div>



HTML
<div style="margin-top: 50px;">
     <h1 style="position: relative;">
        <span style="float: left; margin-right: 10px; width: 30px; height: 30px; border-radius: 50%; background-color: #6b48ff; color: white; text-align: center; line-height: 30px;">9</span>
Datasets
</h1> 
    <h3 style="width: 90%; margin: 20px auto; margin-top: 5px;">Boas práticas garantem que este grande aliado não se torne uma dor de cabeça</h3>
</div>



HTML
<div style="margin-top: 50px;">
     <h1 style="position: relative;">
        <span style="float: left; margin-right: 10px; width: 30px; height: 30px; border-radius: 50%; background-color: #6b48ff; color: white; text-align: center; line-height: 30px;">10</span>
Gestão do Banco de Dados
</h1> 
    <h3 style="width: 90%; margin: 20px auto; margin-top: 5px;">Preocupações em tempo de Projeto, Ações de Rotina e manutenções básicas</h3>
</div>