Acceder a metadatos de instancias

Google Cloud Platform proporciona una servidor de metadatos que conoce detalles acerca de tu instancia de App Engine, como el ID del proyecto al que pertenece, cuentas de servicio y los tokens usados por las cuentas de servicio. Puedes acceder a estos datos a través de solicitudes HTTP simples: no se requieren bibliotecas de cliente.

Esta página muestra cómo acceder a metadatos de instancia desde tu aplicación de entorno de ejecución de Java 8 implementada a través de llamadas HTTP a los extremos del servidor de metadatos adecuados.

Nota: En la actualidad, el acceso a los metadatos es de solo lectura: no puedes escribir tus propios metadatos para una instancia.

Una forma muy útil de usar esta API es obtener el token de la cuenta de servicio y proporcionarlo como un token del portador en el encabezado de Autorización de una de las API de Google Cloud, para autenticar tu aplicación en ese servicio de API particular. Consulta la documentación de la API de Google Cloud Translation para ver un ejemplo de cómo se usan estos tokens del portador.

Identificar qué extremo de metadatos usar

En la tabla siguiente, se enumeran los extremos en los que puedes realizar solicitudes HTTP para metadatos específicos. Se puede acceder al servidor de metadatos en http://metadata.google.internal.

Extremo de metadatos	Descripción
/computeMetadata/v1/project/numeric-project-id	El número de proyecto asignado a tu proyecto.
/computeMetadata/v1/project/project-id	El ID del proyecto asignado a tu proyecto.
/computeMetadata/v1/instance/zone	La zona en la que se está ejecutando la instancia.
/computeMetadata/v1/instance/service-accounts/default/aliases
/computeMetadata/v1/instance/service-accounts/default/email	El correo electrónico de la cuenta de servicio predeterminada asignado a tu proyecto.
/computeMetadata/v1/instance/service-accounts/default/	Enumera todas las cuentas de servicio predeterminadas para tu proyecto.
/computeMetadata/v1/instance/service-accounts/default/scopes	Enumera todos los alcances compatibles para las cuentas de servicio predeterminadas.
/computeMetadata/v1/instance/service-accounts/default/token	Muestra el token de autenticación que puede usarse para autenticar tu aplicación en otras API de Google Cloud.

Por ejemplo, para recuperar tu ID del proyecto, envía una solicitud a http://metadata.google.internal/computeMetadata/v1/project/project-id.

Realizar solicitudes de metadatos

Importante: El acceso al servidor de metadatos debe ser mediante sockets nativos, como los que proporcionan java.net.HttpURLConnection o el url-stream-handler nativo. El servidor de metadatos no admite el servicio urlfetch.

El código de muestra siguiente obtiene todos los metadatos disponibles para la instancia y los muestra, excepto para el token de la cuenta de servicio.

appengine-java8/metadata/src/main/java/com/example/appengine/standard/MetadataServlet.java

Ver en GitHub

@SuppressWarnings("serial")
// With @WebServlet annotation the webapp/WEB-INF/web.xml is no longer required.
@WebServlet(name = "Metadata", description = "Metadata: Write info about GAE Standard",
    urlPatterns = "/metadata")
public class MetadataServlet extends HttpServlet {

  private final String[] metaPath = {
      "/computeMetadata/v1/project/numeric-project-id", //  (pending)
      "/computeMetadata/v1/project/project-id",
      "/computeMetadata/v1/instance/zone",
      "/computeMetadata/v1/instance/service-accounts/default/aliases",
      "/computeMetadata/v1/instance/service-accounts/default/email",
      "/computeMetadata/v1/instance/service-accounts/default/",
      "/computeMetadata/v1/instance/service-accounts/default/scopes",
      // Tokens work - but are a security risk to display
      //      "/computeMetadata/v1/instance/service-accounts/default/token"
  };

  final String[] metaServiceAcct = {
      "/computeMetadata/v1/instance/service-accounts/{account}/aliases",
      "/computeMetadata/v1/instance/service-accounts/{account}/email",
      "/computeMetadata/v1/instance/service-accounts/{account}/scopes",
      // Tokens work - but are a security risk to display
      //     "/computeMetadata/v1/instance/service-accounts/{account}/token"
  };

  private final String metadata = "http://metadata.google.internal";
  private TemplateEngine templateEngine;

  // Use OkHttp from Square as it's quite easy to use for simple fetches.
  private final OkHttpClient ok = new OkHttpClient.Builder()
      .readTimeout(500, TimeUnit.MILLISECONDS)  // Don't dawdle
      .writeTimeout(500, TimeUnit.MILLISECONDS)
      .build();

  // Setup to pretty print returned json
  private final Gson gson = new GsonBuilder()
      .setPrettyPrinting()
      .create();
  private final JsonParser jp = new JsonParser();

  // Fetch Metadata
  String fetchMetadata(String key) throws IOException {
    Request request = new Request.Builder()
        .url(metadata + key)
        .addHeader("Metadata-Flavor", "Google")
        .get()
        .build();

    Response response = ok.newCall(request).execute();
    return response.body().string();
  }

  String fetchJsonMetadata(String prefix) throws IOException {
    Request request = new Request.Builder()
        .url(metadata + prefix)
        .addHeader("Metadata-Flavor", "Google")
        .get()
        .build();

    Response response = ok.newCall(request).execute();

    // Convert json to prety json
    return gson.toJson(jp.parse(response.body().string()));
  }

  @Override
  public void init() {
    // Setup ThymeLeaf
    ServletContextTemplateResolver templateResolver =
        new ServletContextTemplateResolver(this.getServletContext());

    templateResolver.setPrefix("/WEB-INF/templates/");
    templateResolver.setSuffix(".html");
    templateResolver.setCacheTTLMs(Long.valueOf(1200000L)); // TTL=20m

    // Cache is set to true by default. Set to false if you want templates to
    // be automatically updated when modified.
    templateResolver.setCacheable(true);

    templateEngine = new TemplateEngine();
    templateEngine.setTemplateResolver(templateResolver);
  }

  @Override
  public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
    String defaultServiceAccount = "";
    WebContext ctx = new WebContext(req, resp, getServletContext(), req.getLocale());

    resp.setContentType("text/html");

    String environment =
        (String) System.getProperties().get("com.google.appengine.runtime.environment");
    ctx.setVariable("production", environment);

    // The metadata server is only on a production system
    if (environment.equals("Production")) {

      TreeMap<String, String> m = new TreeMap<>();

      for (String key : metaPath) {
        m.put(key, fetchMetadata(key));
        if (key.contains("default/email")) {
          defaultServiceAccount = m.get(key);
        }
      }

      ctx.setVariable("Metadata", m.descendingMap());

      m = new TreeMap<>();
      for (String key : metaServiceAcct) {
        // substitute a service account for {account}
        key = key.replace("{account}", defaultServiceAccount);
        m.put(key, fetchMetadata(key));
      }
      ctx.setVariable("sam", m.descendingMap());

      // Recursivly get all info about service accounts -- Note tokens are leftout by default.
      ctx.setVariable("rsa",
          fetchJsonMetadata("/computeMetadata/v1/instance/service-accounts/?recursive=true"));
      // Recursivly get all data on Metadata server.
      ctx.setVariable("ram", fetchJsonMetadata("/?recursive=true"));
    }

    templateEngine.process("index", ctx, resp.getWriter());

  }
}

En el código de muestra, observa la marca para asegurarte de que la aplicación se está ejecutando en producción. Si la aplicación se está ejecutando localmente, no se mostrarán metadatos de las solicitudes.

Además, observa el uso del serializador/deserializador JSON de Google Gson, el cliente HTTP y HTTP2 de OkHttp, y el sistema de plantillas Thymeleaf. Estos no son necesarios, pero son bibliotecas muy útiles para tus propios proyectos.

Ejecución local

El servidor de metadatos está disponible para aplicaciones implementadas: no se admite la ejecución local en el servidor de desarrollo. Puedes agregar una marca de entorno a tu código para esperar resultados de metadatos, solo si la app se está ejecutando en producción, como se muestra en el código de muestra que se proporciona arriba:

String environment =
      (String) System.getProperties().get("com.google.appengine.runtime.environment");
  ctx.setVariable("production", environment);

  // The metadata server is only on a production system
  if (environment.equals("Production")) {
     ... //show metadata results
   }