Link Search Menu Expand Document

Getting Started

Table of contents

  1. Installation
  2. Running a service
  3. Calling a service
    1. With the CLI
    2. With the framework
    3. From other languages
  4. Creating a service
  5. Storage
    1. Interfaces as building blocks
    2. Using the Store
      1. With the CLI
      2. With the framework
  6. Updating a service
  7. Config
    1. CLI
    2. With the framework
  8. Further reading

Installation

Using Go:

go get github.com/micro/micro/v2

Or by downloading the binary

# MacOS
curl -fsSL https://raw.githubusercontent.com/micro/micro/master/scripts/install.sh | /bin/bash

# Linux
wget -q  https://raw.githubusercontent.com/micro/micro/master/scripts/install.sh -O - | /bin/bash

# Windows
powershell -Command "iwr -useb https://raw.githubusercontent.com/micro/micro/master/scripts/install.ps1 | iex"

Running a service

Before diving into writing a service, let’s run an existing one, because it’s just a few commands away!

First, we have to start the micro server. The command to do that is:

micro server

If all goes well you’ll see log output from the various services initialising; this terminal will continue to output logs as we go through the rest of the tutorial so keep it running.

To talk to this server, we just have to tell Micro CLI to address our server instead of using the default implementations - micro can work without a server too, but more about that later.

The following command tells the CLI to talk to our server:

micro env set server

Great! We are ready to roll. Just to verify that everything is in order, let’s see what services are running:

$ micro list services
go.micro.api
go.micro.auth
go.micro.bot
go.micro.broker
go.micro.config
go.micro.debug
go.micro.network
go.micro.proxy
go.micro.registry
go.micro.router
go.micro.runtime
go.micro.server
go.micro.web

All those services are ones started by our micro server. This is pretty cool, but still it’s not something we launched! Let’s start a service for which existence we can actually take credit for. If we go to github.com/micro, we see a bunch of services written by micro authors. One of them is the helloworld. Try our luck, shall we?

The command to run services is micro run.

micro run github.com/micro/services/helloworld

If we take a look at the running micro server, we should see something like

Creating service micro/services/helloworld version latest source github.com/micro/services/helloworld
Processing create event for service micro/examples/helloworld:latest in namespace micro

We can also have a look at logs of the service to verify it’s running.

$ micro logs micro/services/helloworld
Starting [service] go.micro.service.helloworld
Server [grpc] Listening on [::]:36577
Registry [service] Registering node: go.micro.service.helloworld-213b807a-15c2-496f-93ac-7949ad38aadf

So since our service is running happily, let’s try to call it! That’s what services are for.

Calling a service

We have a couple of options to call a service running on our micro server.

With the CLI

The easiest is perhaps with the CLI:

$ micro call go.micro.service.helloworld Helloworld.Call '{"name":"Jane"}'
{
	"msg": "Hello Jane"
}

That worked! If we wonder what nodes and endpoints a service has we can run the following command:

micro get service go.micro.service.helloworld

With the framework

Let’s write a small client we can use to call the helloworld service. Normally you’ll make a service call inside another service so this is just a sample of a function you may write. We’ll learn how to write a full fledged service soon.

Let’s take the following file:

package main

import (
	"context"
	"fmt"
	"time"

	"github.com/micro/go-micro/v2"
	proto "github.com/micro/services/helloworld/proto"
)

func main() {
	// create and initialise a new service
	service := micro.NewService()
	service.Init()

	// create the proto client for helloworld
	client := proto.NewHelloworldService("go.micro.service.helloworld", service.Client())

	// call an endpoint on the service
	rsp, err := client.Call(context.Background(), &proto.Request{
		Name: "John",
	})
	if err != nil {
		fmt.Println("Error calling helloworld: ", err)
		return
	}

	// print the response
	fmt.Println("Response: ", rsp.Msg)
	
	// let's delay the process for exiting for reasons you'll see below
	time.Sleep(time.Second * 5)
}

Save the example locally. For ease of following this guide, name the folder example-service. After doing a cd example-service && go mod init example, we are ready to run this service with micro run:

micro run .

micro runs, when successful, do not print any output. A useful command to see what is running, is micro status. At this point we should have two services running:

$ micro status
NAME						VERSION	SOURCE										STATUS		BUILD	UPDATED		METADATA
example-service				latest	/home/username/example-service				starting	n/a		4s ago		owner=n/a,group=n/a
micro/examples/helloworld	latest	github.com/micro/services/helloworld		running		n/a		unknown		owner=n/a,group=n/a

Now, since our example-service client is also running, we should be able to see it’s logs:

$ micro logs example-service
# some go build output here
Response:  Hello John

Great! That response is coming straight from the helloworld service we started earlier!

From other languages

In the clients repo there are Micro clients for various languages and frameworks. They are designed to connect easily to the live Micro environment or your local one, but more about environments later.

Creating a service

To create a new service, use the micro new command. It should output something reasonably similar to the following:

$ micro new helloworld
Creating service go.micro.service.helloworld in helloworld

.
├── main.go
├── generate.go
├── plugin.go
├── handler
│   └── helloworld.go
├── subscriber
│   └── helloworld.go
├── proto/helloworld
│   └── helloworld.proto
├── Dockerfile
├── Makefile
├── README.md
├── .gitignore
└── go.mod


download protobuf for micro:

brew install protobuf
go get -u github.com/golang/protobuf/proto
go get -u github.com/golang/protobuf/protoc-gen-go
go get github.com/micro/micro/v2/cmd/protoc-gen-micro@master

compile the proto file helloworld.proto:

cd helloworld
protoc --proto_path=.:$GOPATH/src --go_out=. --micro_out=. proto/helloworld/helloworld.proto

As can be seen from the output above, before building the first service, the following tools must be installed:

They are all needed to translate proto files to actual Go code. Protos exist to provide a language agnostic way to describe service endpoints, their input and output types, and to have an efficient serialization format at hand.

Currently Micro is Go focused (apart from the clients mentioned before), but this will change soon.

So once all tools are installed, being inside the service root, we can issue the following command to generate the Go code from the protos:

protoc --proto_path=.:$GOPATH/src --go_out=. --micro_out=. proto/helloworld/helloworld.proto

The generated code must be committed to source control, to enable other services to import the proto when making service calls (see previous section Calling a service.

At this point, we know how to write a service, run it, and call other services too. We have everything at our fingertips, but there are still some missing pieces to write applications. One of such pieces is the store interface, which helps with persistent data storage even without a database.

Storage

Amongst many other useful built-in services Micro includes a persistent storage service for storing data.

Interfaces as building blocks

A quick side note. Micro (the server/CLI) and Go Micro (the framework) are centered around strongly defined interfaces which are pluggable and provide an abstraction for underlying distributed systems concepts. What does this mean?

Let’s take our current case of the store interface. It’s aimed to enable service writers data storage with a couple of different implementations:

  • in memory
  • file storage (default when running micro server)
  • cockroachdb

Similarly, the runtime interface, that allows you to run services in a completely runtime agnostic way has a few implementations:

  • local, which just runs actual processes - aimed at local development
  • kubernetes - for running containers in a highly available and distributed way

This is a recurring theme across Micro interfaces. Let’s take a look at the default store when running micro server.

Using the Store

With the CLI

First, let’s go over the more basic store CLI commands.

To save a value, we use the write command:

micro store write key1 value1

The UNIX style no output meant it was happily saved. What about reading it?

$ micro store read key1
val1

Or to display it in a fancier way, we can use the --verbose or -v flags:

KEY    VALUE   EXPIRY
key1   val1    None

This view is especially useful when we use the --prefix or -p flag, which lets us search for entries which key have certain prefixes.

To demonstrate that first let’s save an other value:

micro store write key2 val2

After this, we can list both key1 and key2 keys as they both share commond prefixes:

$ micro store read --prefix --verbose key
KEY    VALUE   EXPIRY
key1   val1    None
key2   val2    None

There are more to the store, but this knowledge already enables us to be dangerous!

With the framework

Accessing the same data we have just manipulated from our Go Micro services could not be easier. First let’s create an entry that our service can read. This time we will specify the table for the micro store write command too, as each service has its own table in the store:

micro store write --table go.micro.service.example mykey "Hi there"

Let’s modify the example service we wrote previously so instead of calling a service, it reads the above value from a store.

package main

import (
	"fmt"
	"time"

	"github.com/micro/go-micro/v2"
)

func main() {
	service := micro.NewService()

	service.Init(micro.Name("go.micro.service.example"))

	records, err := service.Options().Store.Read("mykey")
	if err != nil {
		fmt.Println("Error reading from store: ", err)
	}

	if len(records) == 0 {
		fmt.Println("No records")
	}
	for _, record := range records {
		fmt.Printf("key: %v, value: %v\n", record.Key, string(record.Value))
	}

	time.Sleep(1 * time.Hour)
}

Updating a service

Now since the example service is running (can be easily verified by micro status), we should not use micro run, but rather micro update to deploy it.

We can simply issue the update command (remember to switch back to the root directory of the example service first):

micro update .

And verify both with the micro server output:

Updating service example-service version latest source /home/username/example-service
Processing update event example-service:latest in namespace default

and micro status:

$ micro status example-service
NAME			VERSION	SOURCE							STATUS		BUILD	UPDATED		METADATA
example-service	latest	example-service.tar.gz			running	n/a	unknown	owner=n/a,group=n/a

that it was updated.

If things for some reason go haywire, we can try the time tested “turning it off and on again” solution and do:

micro kill example-service
micro run example-service

to start with a clean slate.

So once we did update the example service, we should see the following in the logs:

$ micro logs example-service
key: mykey, value: Hi there

Config

Configuration and secrets is an essential part of any production system - let’s see how the Micro config works.

CLI

The most basic example of config usage is the following:

$ micro config set key val
$ micro config get key
val

While this alone is enough for a great many use cases, for purposes of organisation, Micro also support dot notation of keys. Let’s overwrite our keys set previously:

$ micro config set key.subkey val
$ micro config get key.subkey
val

This is fairly straightforward, but what happens when we get key?

$ micro config get key
{"subkey":"val"}

As it can be seen, leaf level keys will return only the value, while node level keys return the whole subtree as a JSON document:

$ micro config set key.othersubkey val2
$ micro config get key
{"othersubkey":"val2","subkey":"val"}

With the framework

Micro configs work very similarly when being called from Go code too:

package main

import (
	"fmt"
	"os"
	"time"

	"github.com/micro/go-micro/v2"
)

func main() {
	// New Service
	service := micro.NewService(
		micro.Name("go.micro.service.config-read"),
		micro.Version("latest"),
	)
	service.Init()
	c := service.Options().Config

	// read config value
	fmt.Println("Value of key.subkey: ", c.Get("key", "subkey").String(""))
}

Assuming the folder name for this service is still example-service (to update the existing service, see updating a service):

$ micro logs example-service
Value of key.subkey:  val

Further reading

This is just a brief getting started guide for quickly getting up and running with Micro. Come back from time to time to learn more as this guide gets continually upgraded. If you’re interested in learning more Micro magic, have a look at the following sources:


Copyright © 2020 Micro Services, Inc.