Classificação: Mongo::Server::AppMetadata::Environment Private

Herda:

Objeto

Objeto
Mongo::Server::AppMetadata::Environment

mostrar tudo

Definido em:: lib/mongo/ servidor/app_metadata/environment.rb

Visão geral

Esta classe faz parte de uma API privada. Evite usar essa classe, se possível, pois ela pode ser removida ou alterada no futuro.

Implementa a lógica da especificação do handshake para deduzir e relatar o ambiente atual no qual o programa está sendo executado.

Isso inclui verificações de ambiente FaaS, bem como verificações da presença de um container (Docker) e/ou orquestrador (Kubernetes).

Desde:

2.0.0

Definido sob namespace

Classes: missingVariable, TooManyEnvironments, TypeMismatch, ValueTooLong

Colapsode resumo constante

DOCKERENV_PATH =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro.

O nome e a localização do arquivo .dockerenv que sinalizará a presença do Docker.

Desde:

2.0.0

'/.dockerenv'

MAXIMUM_VALUE_LENGTH =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro.

Este valor não é explicitamente especificado nas especificações, apenas implícito ser menor que 512.

Desde:

2.0.0

Discriminadores =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro.

O mapeamento que determina qual ambiente FaaS está ativo, com base em quais variáveis de ambiente estão presentes.

Desde:

2.0.0

{
  'AWS_EXECUTION_ENV' => { padrão: /^AWS_Lambda_/, nome: 'aws.lambda' },
  'AWS_LAMBDA_RUNTIME_API' => { nome: 'aws.lambda' },
  'FUNCTIONS_WORKER_RUNTIME' => { nome: 'azure.func' },
  'K_SERVICE' => { nome: 'gcp.func' },
  'FUNCTION_NAME' => { nome: 'gcp.func' },
  'VERCEL' => { nome: 'vercel' },
}.congelar

COERTION =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro.

Descreve como forçar valores do tipo especificado.

Desde:

2.0.0

{
  string: ->(v) { String(v) },
  inteiro: ->(v) { Inteiro(v) }
}.congelar

Campos =

Essa constante faz parte de uma API privada. Você deve evitar usar essa constante, se possível, pois ela pode ser removida ou alterada no futuro.

Descreve quais campos são necessários para cada ambiente FaaS, juntamente com seus tipos esperados, e como devem ser nomeados no documento de handshake.

Desde:

2.0.0

{
  'aws.lambda' => {
    'AWS_REGION' => { campo: :region, tipo: : string },
    'AWS_LAMBDA_FUNCTION_MEMORY_SIZE' => { campo: :memory_mb, tipo: :integer },
  },

  'azure.func' => {},

  'gcp.func' => {
    'FUNCTION_MEMORY_MB' => { campo: :memory_mb, tipo: :integer },
    'FUNCTION_TIMEOUT_SEC' => { campo: :timeout_sec, tipo: :integer },
    'FUNCTION_REGION' => { campo: :region, tipo: : string },
  },

  'vercel' => {
    'VERCEL_REGION' => { campo: :region, tipo: : string },
  },
}.congelar

Recolhimento do Resumo do atributo de instância

#erro ➤ string | nada Somente leitura privado

A mensagem de erro explicando por que um ambiente FaaS válido não foi detectado, ou nulo se nenhum erro ocorreu.
#campos ➤ Hash | nada Somente leitura privado

Os campos descrevendo o ambiente FaaS detectado.
#nome ➤ string | nada Somente leitura privado

O nome do ambiente FaaS que foi detectado ou nulo se nenhum ambiente FaaS válido foi detectado.

Recolhimento do Resumo do método de instância

#Amazon Web Services? ➤ verdadeiro | false privado

Consulta se o ambiente atual é um ambiente válido do Amazon Web Services Lambda .
#Azure? ➤ verdadeiro | false privado

Consulta se o ambiente atual é um ambiente Azure válido.
#container ➤ Hash | nada privado

Consulta as informações do container detectado.
#faas? ➤ verdadeiro | false privado

Consulta se o ambiente atual é um ambiente FaaS válido.
#GCP? ➤ verdadeiro | false privado

Consulta se o ambiente atual é um ambiente GCP válido.
#inicializar ➤ Ambiente construtor privado

Crie um novo objeto AppMetadata::Environment , inicializando-o a partir das variáveis ENV atuais.
#presente? ➤ verdadeiro | false privado

Consulta se alguma informação do ambiente pôde ser detectada.
#to_h ➤ Hash privado

Compila as informações do ambiente detectadas em um Hash.
#vercel? ➤ verdadeiro | false privado

Consulta se o ambiente atual é um ambiente Vercel válido.

Detalhes do construtor

#inicializar ➤ `Ambiente`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Crie um novo objeto AppMetadata::Environment , inicializando-o a partir das variáveis ENV atuais. Se nenhum ambiente FaaS for detectado ou se o ambiente contiver um estado inválido ou contraditório, ele será inicializado com {name} definido como {nil}.

Desde:

2.0.0

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 111

def inicializar
  @fields = {}
  @erro = nada
  @name = detect_environment
  preenchimento_faas_fields
  detect_container
salvar ToManyEnvironments => e
  auto.Erro = "muitos ambientes detectados: #{e.message}"
salvar missingVariable => e
  auto.Erro = "variável de ambiente ausente: #{e.message}"
salvar TypeMismatch => e
  auto.Erro = e.mensagem
salvar ValueTooLong => e
  auto.Erro = "o valor para #{e.message} é muito longo"
end

Detalhes do atributo da instância

#error ⇒ `String | nil`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Observação:

Essas mensagens de erro não devem ser propagadas ao usuário; eles destinam-se apenas à solução de problemas e depuração.)

Retorna a mensagem de erro explicando por que um ambiente FaaS válido não foi detectado, ou nulo se nenhum erro ocorrer.

Retorna:

(string | nil) —

a mensagem de erro explicando por que um ambiente FaaS válido não foi detectado ou nulo se nenhum erro ocorrer.

Desde:

2.0.0



105
106
107

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 105

def Erro
  @erro
end

#campos ➤ `Hash | nil` (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Retorna os campos descrevendo o ambiente FaaS detectado.

Retorna:

(Hash | nulo) —

os campos que descrevem o ambiente FaaS detectado.

Desde:

2.0.0



98
99
100

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 98

def Campos
  @fields
end

#nome ➤ `string | nil` (somente leitura)

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Retorna o nome do ambiente FaaS que foi detectado ou nulo se nenhum ambiente FaaS válido foi detectado.

Retorna:

(string | nil) —

o nome do ambiente FaaS que foi detectado ou nulo se nenhum ambiente FaaS válido foi detectado.

Desde:

2.0.0



94
95
96

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 94

def name
  @name
end

Detalhes do método de instância

#Amazon Web Services? ➤ `verdadeiro | false`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Consulta se o ambiente atual é um ambiente válido do Amazon Web Services Lambda .

Retorna:

(verdadeiro | falso) —

se o ambiente é um ambiente Amazon Web Services Lambda ou não.

Desde:

2.0.0



157
158
159

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 157

def Amazon Web Services?
  @name == 'aws.lambda'
end

#Azure? ➤ `verdadeiro | false`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Consulta se o ambiente atual é um ambiente Azure válido.

Retorna:

(verdadeiro | falso) —

se o ambiente é um ambiente Azure ou não.

Desde:

2.0.0



166
167
168

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 166

def Azure?
  @name == 'azure.func'
end

#container ➤ `Hash | nada`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Consulta as informações do container detectado.

Retorna:

(Hash | nulo) —

as informações do contêiner detectadas ou nulo se nenhum contêiner foi detectado.

Desde:

2.0.0



131
132
133

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 131

def container
  Campos[:container]
end

#faas? ➤ `verdadeiro | false`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Consulta se o ambiente atual é um ambiente FaaS válido.

Retorna:

(verdadeiro | falso) —

se o ambiente é um ambiente FaaS ou não.

Desde:

2.0.0



148
149
150

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 148

def faas?
  @name != nada
end

#GCP? ➤ `verdadeiro | false`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Consulta se o ambiente atual é um ambiente GCP válido.

Retorna:

(verdadeiro | falso) —

se o ambiente é um ambiente GCP ou não.

Desde:

2.0.0



175
176
177

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 175

def gcp?
  @name == 'gcp.func'
end

#presente? ➤ `verdadeiro | false`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Consulta se alguma informação do ambiente pôde ser detectada.

Retorna:

(verdadeiro | falso) —

se alguma informação do ambiente foi detectada.

Desde:

2.0.0



140
141
142

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 140

def presente?
  @name || Campos.algum?
end

#to_h ➤ `Hash`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Compila as informações do ambiente detectadas em um Hash.

Retorna:

(Hash) —

as informações do ambiente detectadas.

Desde:

2.0.0



191
192
193

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 191

def to_h
  name ? Campos.mesclar(nome: name) : Campos
end

#vercel? ➤ `verdadeiro | false`

Este método faz parte de uma API privada. Evite usar esse método, se possível, pois ele pode ser removido ou alterado no futuro.

Consulta se o ambiente atual é um ambiente Vercel válido.

Retorna:

(verdadeiro | falso) —

se o ambiente é um ambiente Vercel ou não.

Desde:

2.0.0



184
185
186

# Arquivo 'lib/mongo/ servidor/app_metadata/environment.rb', linha 184

def vercel?
  @name == 'vercel'
end

Classificação: Mongo::Server::AppMetadata::Environment Private

Visão geral

Definido sob namespace

Colapsode resumo constante

Recolhimento do Resumo do atributo de instância

Recolhimento do Resumo do método de instância

Detalhes do construtor

#inicializar ➤ Ambiente

Detalhes do atributo da instância

#error ⇒ String | nil

#campos ➤ Hash | nil (somente leitura)

#nome ➤ string | nil (somente leitura)

Detalhes do método de instância

#Amazon Web Services? ➤ verdadeiro | false

#Azure? ➤ verdadeiro | false

#container ➤ Hash | nada

#faas? ➤ verdadeiro | false

#GCP? ➤ verdadeiro | false

#presente? ➤ verdadeiro | false

#to_h ➤ Hash

#vercel? ➤ verdadeiro | false

#inicializar ➤ `Ambiente`

#error ⇒ `String | nil`

#campos ➤ `Hash | nil` (somente leitura)

#nome ➤ `string | nil` (somente leitura)

#Amazon Web Services? ➤ `verdadeiro | false`

#Azure? ➤ `verdadeiro | false`

#container ➤ `Hash | nada`

#faas? ➤ `verdadeiro | false`

#GCP? ➤ `verdadeiro | false`

#presente? ➤ `verdadeiro | false`

#to_h ➤ `Hash`

#vercel? ➤ `verdadeiro | false`