Gerenciamento de recursos do Python
A biblioteca de gerenciamento de recursos Python fornece uma maneira de desenvolver e expor funcionalidades de aplicativos com base em sinalizadores de recursos. Depois que um novo recurso é desenvolvido, muitos aplicativos têm requisitos especiais, como quando o recurso deve ser habilitado e sob quais condições. Essa biblioteca oferece uma maneira de definir esses relacionamentos e também se integra aos padrões comuns de código do Python para tornar possível a exposição desses recursos.
Sinalizadores de recursos permitem que aplicativos Python ativem ou desativem recursos dinamicamente. Os desenvolvedores podem usar sinalizadores de recursos em casos de uso simples, como instruções condicionais.
Aqui estão alguns dos benefícios de usar a biblioteca de gerenciamento de recursos do Python:
Uma convenção comum para o gerenciamento de recursos
Baixa barreira de entrada
- Dá suporte para a configuração de sinalizadores de recursos em JSON
Gerenciamento do tempo de vida dos sinalizadores de recursos
- Os valores de configuração podem ser alterados em tempo real; sinalizadores de recurso podem ser consistentes em toda a solicitação
Abrange cenários simples a complexos
- Ative/desative recursos por meio do arquivo de configuração declarativa
- Avalie dinamicamente o estado do recurso com base na chamada ao servidor
A biblioteca de gerenciamento de recursos do Python é de código aberto. Para obter mais informações, acesse o repositório do GitHub.
Sinalizadores de recurso
Os sinalizadores de recursos são compostos por duas partes, um nome e uma lista de filtros de recursos usados para ativar o recurso.
Filtros de recursos
Os filtros de recursos definem um cenário para quando um recurso deve ser habilitado. Quando um recurso é avaliado se ele está ativado ou desativado, sua lista de filtros de recursos é percorrida até que um dos filtros decida que o recurso deve ser habilitado. Nesse ponto, o recurso é considerado habilitado e a passagem pelos filtros de recursos é interrompida. Se nenhum filtro de recurso indicar que o recurso deve ser habilitado, ele será considerado desabilitado.
Por exemplo, um filtro de recurso do navegador Microsoft Edge pode ser projetado. Este filtro de recursos ativaria quaisquer recursos a ele associados, desde que uma solicitação HTTP venha do Microsoft Edge.
Configuração do sinalizador de recurso
Um dicionário Python é usado para definir sinalizadores de recursos. O dicionário é composto por nomes de recursos como chaves e objetos de sinalizadores de recursos como valores. O objeto do sinalizador de recurso é um dicionário que contém uma chave conditions, que por sua vez contém a chave client_filters. A chave client_filters é uma lista de filtros de recursos usados para determinar se o recurso deve ser habilitado.
Declaração do sinalizador de recurso
A biblioteca de gerenciamento de recursos dá suporte para JSON como fonte de sinalizadores de recursos. Abaixo temos um exemplo do formato usado para configurar os sinalizadores de recursos em um arquivo JSON.
{
"feature_management": {
"feature_flags": [
{
"id": "FeatureT",
"enabled": "true"
},
{
"id": "FeatureU",
"enabled": "false"
},
{
"id": "FeatureV",
"enabled": "true",
"conditions": {
"client_filters": [
{
"name": "Microsoft.TimeWindow",
"parameters": {
"Start": "Wed, 01 May 2019 13:59:59 GMT",
"End": "Mon, 01 Jul 2019 00:00:00 GMT"
}
}
]
}
}
]
}
}
A seção feature_management do documento json é usada por convenção para carregar as configurações do sinalizador de recurso. A seção feature_flags é uma lista dos sinalizadores de recursos que são carregados na biblioteca. Na seção acima, vemos três recursos diferentes. Os recursos definem seus filtros de recursos usando a propriedade client_filters, dentro de conditions. Nos filtros de recurso para FeatureT, observamos que enabled está ativado sem filtros definidos, resultando em FeatureT sempre retornando true. FeatureU é o mesmo que FeatureT, mas com enabled sendo false, resultando em um recurso que sempre retorna false. FeatureV especifica um filtro de recurso chamado Microsoft.TimeWindow. FeatureV é um exemplo de um filtro de recurso configurável. Podemos ver no exemplo que o filtro tem uma propriedade parameters. A propriedade parameters é usada para configurar o filtro. Nesse caso, os horários de início e término do recurso a ser ativo são configurados.
O esquema detalhado da seção feature_management pode ser encontrado aqui.
Avançado: o uso de dois-pontos ':' é proibido em nomes de sinalizador de recurso.
Declaração de ligado/desligado
O trecho de código a seguir demonstra uma maneira alternativa de definir um recurso que pode ser usado para recursos de ativação/desativação.
{
"feature_management": {
"feature_flags": [
{
"id": "FeatureT",
"enabled": "true"
},
{
"id": "FeatureX",
"enabled": "false"
}
]
}
}
Tipo de requisito
A propriedade requirement_type de um sinalizador de recurso é usada para determinar se os filtros devem usar a lógica Any ou All ao avaliar o estado de um recurso. Se requirement_type não for especificado, o valor padrão será Any.
Anysignifica que apenas um filtro precisa ser avaliado como true para que o recurso seja habilitado.Allsignifica que cada filtro precisa ser avaliado como true para que o recurso seja habilitado.
Um requirement_type de All altera a transversal. Primeiro, se não houver filtros, o recurso será desabilitado. Em seguida, os filtros de recurso são percorridos até que um dos filtros decida que o recurso deve ser desabilitado. Se nenhum filtro indicar que o recurso deve ser desabilitado, ele será considerado habilitado.
{
"feature_management": {
"feature_flags": [
{
"id": "FeatureW",
"enabled": "true",
"conditions": {
"requirement_type": "All",
"client_filters": [
{
"name": "Microsoft.TimeWindow",
"parameters": {
"Start": "Wed, 01 May 2019 13:59:59 GMT",
"End": "Mon, 01 Jul 2019 00:00:00 GMT"
}
},
{
"name": "Percentage",
"parameters": {
"Value": "50"
}
}
]
}
},
]
}
}
No exemplo acima, FeatureW especifica um requirement_type de All, o que significa que todos os seus filtros devem ser avaliados como verdadeiros para que o recurso seja habilitado. Nesse caso, o recurso está habilitado para 50% dos usuários durante a janela de tempo especificada.
Consumo
A forma básica de gerenciamento de recursos é verificar se um sinalizador de recurso está habilitado e executar ações com base no resultado. Verificar o estado de um sinalizador de recurso é feito através do método is_enabled de FeatureManager.
…
feature_manager = FeatureManager(feature_flags)
…
if feature_manager.is_enabled("FeatureX"):
# Do something
O feature_flags fornecido para FeatureManager pode ser AzureAppConfigurationProvider ou um dicionário de sinalizadores de recurso.
Implementando um filtro de recurso
A criação de um filtro de recursos fornece uma maneira de habilitar recursos com base nos critérios definidos por você. Para implementar um filtro de recurso, a interface FeatureFilter deve ser implementada. FeatureFilter tem um único método chamado evaluate. Quando um recurso especifica que ele pode ser habilitado para um filtro de recurso, o método evaluate é chamado. Se evaluate retornar true, significa que o recurso deve ser habilitado.
O trecho de código a seguir demonstra como adicionar um filtro de recurso MyCustomFilter personalizado.
feature_manager = FeatureManager(feature_flags, feature_filters=[MyCustomFilter()])
Filtros de recurso são registrados fornecendo-os à propriedade feature_filters ao criar FeatureManager. Se um filtro de recurso personalizado precisar de algum contexto, eles poderão ser passados ao chamar is_enabled usando kwargs.
Atributo de alias de filtro
Quando um filtro de recurso é registrado para um sinalizador de recurso, o nome do filtro é usado como alias por padrão.
O identificador para o filtro de recurso pode ser substituído usando o @FeatureFilter.alias("MyFilter"). Um filtro de recurso pode ser decorado com esse atributo para declarar o nome que deve ser usado na configuração para referenciar esse filtro de recurso dentro de um sinalizador de recurso.
Filtros de recurso ausentes
Se um recurso estiver configurado para ser habilitado para um filtro de recurso específico e esse filtro de recurso não estiver registrado, uma exceção ValueError será gerada quando o recurso for avaliado.
Filtros de recurso internos
Existem dois filtros de recurso que acompanham o pacote FeatureManagement: TimeWindowFilter e TargetingFilter.
Cada um dos filtros de recursos internos tem seus próprios parâmetros. Aqui está a lista de filtros de recursos junto com exemplos.
Microsoft.TimeWindow
Esse filtro fornece a capacidade de habilitar um recurso com base em uma janela de tempo. Se apenas End for especificado, o recurso será considerado até esse momento. Se apenas Start for especificado, o recurso será considerado em todos os pontos após esse tempo.
"client_filters": [
{
"name": "Microsoft.TimeWindow",
"parameters": {
"Start": "Wed, 01 May 2019 13:59:59 GMT",
"End": "Mon, 01 Jul 2019 00:00:00 GMT"
}
}
]
Microsoft.Targeting
Esse filtro fornece a capacidade de habilitar um recurso para um público-alvo. Uma explicação detalhada do direcionamento é explicada na seção direcionamento abaixo. Os parâmetros de filtro incluem um objeto Audience que descreve usuários, grupos, usuários/grupos excluídos e um percentual padrão da base de usuários que deve ter acesso ao recurso. Cada objeto de grupo listado na seção Groups também deve especificar qual porcentagem dos membros do grupo deve ter acesso. Se um usuário for especificado na seção Exclusion, diretamente ou se o usuário estiver em um grupo excluído, o recurso será desabilitado. Caso contrário, se um usuário for especificado diretamente na seção Users ou se o usuário estiver no percentual incluído de qualquer uma das distribuições de grupo ou se o usuário se enquadrar no percentual de distribuição padrão, esse usuário terá o recurso habilitado.
"client_filters": [
{
"name": "Microsoft.Targeting",
"parameters": {
"Audience": {
"Users": [
"Jeff",
"Alicia"
],
"Groups": [
{
"Name": "Ring0",
"RolloutPercentage": 100
},
{
"Name": "Ring1",
"RolloutPercentage": 50
}
],
"DefaultRolloutPercentage": 20,
"Exclusion": {
"Users": [
"Ross"
],
"Groups": [
"Ring2"
]
}
}
}
}
]
Direcionamento
A segmentação é uma estratégia de gerenciamento de recursos que permite aos desenvolvedores implementar progressivamente novos recursos para sua base de usuários. A estratégia baseia-se no conceito de atingir um conjunto de usuários conhecido como público-alvo. Um público é composto por usuários, grupos específicos e uma porcentagem designada de toda a base de usuários. Os grupos incluídos na audiência podem ser divididos ainda mais em percentuais de seus membros totais.
As etapas a seguir demonstram um exemplo de uma distribuição progressiva para um novo recurso "Beta":
- Os usuários individuais Jonas e Alice recebem acesso ao Beta
- Outro usuário, Mark, pede para aceitar e é incluído.
- Vinte por cento de um grupo conhecido como usuários "Ring1" estão incluídos no Beta.
- O número de usuários "Ring1" incluídos no beta é aumentado para 100%.
- Cinco por cento da base de usuários está incluída na versão beta.
- O percentual de distribuição é aumentado em até 100% e o recurso é completamente distribuído.
Essa estratégia para implementar um recurso é interna à biblioteca através do filtro de recurso incluído Microsoft.Targeting.
Direcionando um usuário
Ou um usuário pode ser especificado diretamente na chamada is_enabled ou um TargetingContext pode ser usado para especificar o usuário e o grupo opcional.
# Directly specifying the user
result = is_enabled(feature_flags, "test_user")
# Using a TargetingContext
result = is_enabled(feature_flags, TargetingContext(user_id="test_user", groups=["Ring1"]))
Exclusão de direcionamento
Ao definir um público-alvo, usuários e grupos podem ser excluídos do público-alvo. Exclusões são úteis quando um recurso está sendo distribuído para um grupo de usuários, mas alguns usuários ou grupos precisam ser excluídos da distribuição. A exclusão é definida adicionando uma lista de usuários e grupos à propriedade Exclusion do público-alvo.
"Audience": {
"Users": [
"Jeff",
"Alicia"
],
"Groups": [
{
"Name": "Ring0",
"RolloutPercentage": 100
}
],
"DefaultRolloutPercentage": 0
"Exclusion": {
"Users": [
"Mark"
]
}
}
No exemplo acima, o recurso está habilitado para usuários chamados Jeff e Alicia. Ele também está habilitado para usuários no grupo chamado Ring0. No entanto, se o usuário for chamado Mark, o recurso será desabilitado, independentemente de estar no grupo Ring0 ou não. As exclusões têm prioridade sobre o restante do filtro de direcionamento.
Variantes
Quando novos recursos são adicionados a um aplicativo, pode chegar um momento em que um recurso tem várias opções de design propostas diferentes. Uma solução comum para decidir sobre um design é alguma forma de teste A/B. O teste A/B envolve fornecer uma versão diferente do recurso para diferentes segmentos da base de usuários e escolher uma versão baseada na interação do usuário. Nesta biblioteca, essa funcionalidade é habilitada por meio da representação de diferentes configurações de um recurso com variantes.
As variantes permitem que um sinalizador de recurso se torne mais do que um sinalizador simples de ativação/desativação. Uma variante representa um valor de um sinalizador de recurso que pode ser uma cadeia de caracteres, um número, um booliano ou até mesmo um objeto de configuração. Um sinalizador de recurso que declara variantes deve definir em quais circunstâncias cada variante deve ser usada, o que é abordado em maior detalhe na seção Alocação de variantes.
class Variant:
def __init__(self, name: str, configuration: Any):
self._name = name
self._configuration = configuration
@property
def name(self) -> str:
"""
The name of the variant.
:rtype: str
"""
return self._name
@property
def configuration(self) -> Any:
"""
The configuration of the variant.
:rtype: Any
"""
return self._configuration
Obtendo variantes
Para cada recurso, uma variante pode ser recuperada usando o método FeatureManager do get_variant.
…
variant = print(feature_manager.get_variant("TestVariants", TargetingContext(user_id="Adam"))
variantConfiguration = variant.configuration;
// Do something with the resulting variant and its configuration
A variante retornada depende do usuário que está sendo avaliado no momento e essas informações são obtidas de uma instância de TargetingContext.
Declaração do sinalizador de recurso variante
Comparado aos sinalizadores de recurso normais, os sinalizadores de recurso variantes têm mais duas propriedades: variants e allocation. A propriedade variants é uma matriz que contém as variantes definidas para esse recurso. A propriedade allocation define como essas variantes devem ser alocadas para o recurso. Assim como ao declarar sinalizadores de recurso normais, você pode configurar sinalizadores de recurso variantes em um arquivo JSON. Aqui está um exemplo de um sinalizador de recurso variante.
{
"feature_management": {
"feature_flags": [
{
"id": "MyVariantFeatureFlag",
"enabled": true,
"allocation": {
"default_when_enabled": "Small",
"group": [
{
"variant": "Big",
"groups": [
"Ring1"
]
}
]
},
"variants": [
{
"name": "Big"
},
{
"name": "Small"
}
]
}
]
}
}
Definindo variantes
Cada variante tem duas propriedades: um nome e uma configuração. O nome é usado para se referir a uma variante específica e a configuração é o valor dessa variante. A configuração pode ser definida usando a propriedade configuration_value. configuration_value é uma configuração embutida que pode ser uma cadeia de caracteres, número, booliano ou objeto de configuração. Se configuration_value não for especificado, a propriedade Configuration da variante retornada será None.
Uma lista de todas as variantes possíveis é definida para cada recurso na propriedade variants.
{
"feature_management": {
"feature_flags": [
{
"id": "MyVariantFeatureFlag",
"variants": [
{
"name": "Big",
"configuration_value": {
"Size": 500
}
},
{
"name": "Small",
"configuration_value": {
"Size": 300
}
}
]
}
]
}
}
Alocando variantes
O processo de alocação das variantes de um recurso é determinado pela propriedade allocation do recurso.
"allocation": {
"default_when_enabled": "Small",
"default_when_disabled": "Small",
"user": [
{
"variant": "Big",
"users": [
"Marsha"
]
}
],
"group": [
{
"variant": "Big",
"groups": [
"Ring1"
]
}
],
"percentile": [
{
"variant": "Big",
"from": 0,
"to": 10
}
],
"seed": "13973240"
},
"variants": [
{
"name": "Big",
"configuration_value": "500px"
},
{
"name": "Small",
"configuration_value": "300px"
}
]
A configuração allocation de um recurso tem as seguintes propriedades:
| Propriedade | Descrição |
|---|---|
default_when_disabled |
Especifica qual variante deve ser usada quando uma variante é solicitada enquanto o recurso é considerado desabilitado. |
default_when_enabled |
Especifica qual variante deve ser usada quando uma variante é solicitada enquanto o recurso é considerado habilitado e nenhuma outra variante foi atribuída ao usuário. |
user |
Especifica uma variante e uma lista de usuários aos quais essa variante deve ser atribuída. |
group |
Especifica uma variante e uma lista de grupos. A variante é atribuída se o usuário estiver em pelo menos um dos grupos. |
percentile |
Especifica uma variante e um intervalo de porcentagem em que o percentual calculado do usuário precisa se ajustar para que essa variante seja atribuída. |
seed |
O valor no qual os cálculos de porcentagem para percentile se baseiam. O cálculo de porcentagem para um usuário específico será o mesmo em todos os recursos se o mesmo valor seed for usado. Se nenhum seed for especificado, uma semente padrão será criada com base no nome do recurso. |
Se o recurso não estiver habilitado, o gerente de recursos atribuirá a variante marcada como default_when_disabled ao usuário atual, que neste caso será Small.
Se o recurso estiver habilitado, o gerente de recursos verificará as alocações user, group e percentile nessa ordem para atribuir uma variante. Para este exemplo específico, se o usuário que está sendo avaliado for nomeado Marsha, no grupo nomeado Ring1, ou se o usuário estiver entre o percentil 0 e 10, a variante especificada será atribuída ao usuário. Nesse caso, todos os usuários atribuídos retornariam a variante Big. Se nenhuma dessas alocações corresponder, o usuário recebe a variante default_when_enabled, que é Small.
A lógica de alocação é semelhante ao filtro de recursos Microsoft.Targeting, mas há alguns parâmetros presentes no direcionamento que não estão em alocação e vice-versa. Os resultados de direcionamento e alocação não estão relacionados.
Substituindo o estado habilitado com uma variante
Você pode usar variantes para substituir o estado habilitado de um sinalizador de recurso. A substituição dá às variantes a oportunidade de estender a avaliação de um sinalizador de recurso. Ao chamar is_enabled em um sinalizador com variantes, o gerenciador de recursos verificará se a variante atribuída ao usuário atual está configurada para substituir o resultado. A substituição é feita usando a propriedade de variante opcional status_override. Por padrão, essa propriedade é definida como None, o que significa que a variante não afeta se o sinalizador é considerado habilitado ou desabilitado. A configuração status_override para Enabled permite que a variante, quando escolhida, substitua um sinalizador a ser habilitado. A configuração status_override para Disabled fornece a funcionalidade oposta, desabilitando o sinalizador quando a variante for escolhida. Um recurso com um estado enabled de false não pode ser substituído.
Se você estiver usando um sinalizador de recurso com variantes binárias, a propriedade status_override pode ser útil. Isso permite que você continue usando APIs como is_enabled em seu aplicativo, beneficiando-se das novas funcionalidades que acompanham as variantes, como alocação de percentil e semente.
{
"id": "MyVariantFeatureFlag",
"enabled": true,
"allocation": {
"percentile": [
{
"variant": "On",
"from": 10,
"to": 20
}
],
"default_when_enabled": "Off",
"seed": "Enhanced-Feature-Group"
},
"variants": [
{
"name": "On"
},
{
"name": "Off",
"status_override": "Disabled"
}
]
}
No exemplo acima, o recurso está sempre habilitado. Se o usuário atual estiver no intervalo de percentil calculado de 10 a 20, a variante On será retornada. Caso contrário, a variante Off será retornada e, como status_override é igual a Disabled, o recurso agora será considerado desabilitado.
Telemetria
Quando uma alteração de sinalizador de recurso é implantada, geralmente é importante analisar seu efeito em um aplicativo. Por exemplo, aqui estão algumas perguntas que podem surgir:
- Meus sinalizadores estão habilitados/desabilitados conforme o esperado?
- Os usuários direcionados estão recebendo acesso a um determinado recurso conforme o esperado?
- Qual variante um usuário específico vê?
Esses tipos de perguntas podem ser respondidas por meio da emissão e análise de eventos de avaliação do sinalizador de recurso. Essa biblioteca opcionalmente permite AzureMonitor produzir telemetria de rastreamento durante a avaliação do sinalizador de recurso via OpenTelemetry.
Habilitando a telemetria
Por padrão, os sinalizadores de recursos não têm telemetria emitida. Para publicar a telemetria para um sinalizador de recurso específico, o sinalizador DEVE declarar que está habilitado para emissão de telemetria.
Para sinalizadores de recurso definidos em JSON, a habilitação é feita usando a propriedade telemetry.
{
"feature_management": {
"feature_flags": [
{
"id": "MyFeatureFlag",
"enabled": true,
"telemetry": {
"enabled": true
}
}
]
}
}
O trecho acima define um sinalizador de recurso chamado MyFeatureFlag que está habilitado para telemetria. A propriedade enabled do objeto telemetry está configurada para true. O valor da propriedade enabled deve ser true para publicar telemetria para o sinalizador.
A seção telemetry de um sinalizador de recurso tem as seguintes propriedades:
| Propriedade | Descrição |
|---|---|
enabled |
Especifica se a telemetria deve ser publicada para o sinalizador de recurso. |
metadata |
Uma coleção de pares chave-valor, modelada como um dicionário, que pode ser usada para anexar metadados personalizados sobre o sinalizador de recurso a eventos de avaliação. |
Além disso, ao criar FeatureManager, um retorno de chamada deve ser registrado para lidar com eventos de telemetria. Esse retorno de chamada é chamado sempre que um sinalizador de recurso é avaliado e a telemetria está habilitada para esse sinalizador.
feature_manager = FeatureManager(feature_flags, on_feature_evaluated=publish_telemetry)
Application Insights Telemetry
A biblioteca de gerenciamento de recursos fornece um publicador de telemetria interno que envia dados de avaliação de sinalizador de recurso para o Application Insights. Para habilitar o Application Insights, a biblioteca de gerenciamento de recursos pode ser instalada com o Azure Monitor via pip install FeatureManagement[AzureMonitor]. Esse comando instala o pacote azure-monitor-events-extension, que é usado para estilizar a telemetria para o Application Insights usando o OpenTelemetry.
Observação
O pacote azure-monitor-events-extension apenas adiciona a telemetria ao pipeline do Open Telemetry. Ainda é necessário registrar o Application Insights.
from azure.monitor.opentelemetry import configure_azure_monitor
configure_azure_monitor(
connection_string="InstrumentationKey=00000000-0000-0000-0000-000000000000"
)
Publicação de telemetria personalizada
Como o retorno de chamada de telemetria é uma função, ele pode ser personalizado para publicar telemetria em qualquer destino desejado. Por exemplo, a telemetria poderia ser publicada em um serviço de registro, um banco de dados ou um serviço de telemetria personalizado.
Quando um sinalizador de recurso é avaliado e a telemetria está habilitada, o gerenciador de recursos chama o retorno de chamada de telemetria com um parâmetro EvaluationEvent. EvaluationEvent contém as propriedades a seguir:
| Marca | Descrição |
|---|---|
feature |
O sinalizador de recurso usado. |
user |
A ID do usuário usada para o direcionamento. |
enabled |
Se o sinalizador de recurso é avaliado como habilitado. |
Variant |
A variante atribuída. |
VariantAssignmentReason |
O motivo pelo qual a variante é atribuída. |
Próximas etapas
Para saber como usar sinalizadores de recursos em seus aplicativos, prossiga para os seguintes guias de início rápido.
Para saber como usar filtros de recursos, prossiga para os seguintes tutoriais.